-
-
Notifications
You must be signed in to change notification settings - Fork 31.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
String escape sequences should be listed in the stdtypes page #103360
Comments
The reference for string/bytes literals belongs where it is, the Literals section of the reference manual. The string and bytes doc already has a cross-reference to that section. We might consider making "escape sequences" in that sentence link to the table. Or we could add a subsection header "String escape sequences" above the table and link to that. This might improve search. The current subsection is pretty long and escape sequences should be as prominent as string concatenation, which is a rather small subsection. |
This commit addresses issue python#103360 by adding a subsection header "String escape sequences" above the escape sequences table in lexical_analysis.rst, and referencing that subsection header in stdtypes.rst where the documentation mentions supported escape sequences under "Text Sequence Type - str".
I think this is solved by the PR, but the PR got stale somehow (CI results are outdated by now). |
…cal_analysis.rst (pythonGH-103638) (cherry picked from commit d29f57f) Co-authored-by: Justin Williams <[email protected]>
…cal_analysis.rst (pythonGH-103638) (cherry picked from commit d29f57f) Co-authored-by: Justin Williams <[email protected]>
…ical_analysis.rst (GH-103638) (GH-114907) (cherry picked from commit d29f57f) Co-authored-by: Justin Williams <[email protected]>
…ical_analysis.rst (GH-103638) (#114908) (cherry picked from commit d29f57f) Co-authored-by: Justin Williams <[email protected]> Co-authored-by: Terry Jan Reedy <[email protected]>
Documentation
Since string escape sequences are FREQUENTLY used and referred to, they should be listed on the Built In Types page, not tucked away in an obscure lexical analysis page :( Finding it from a search engine is just HORRIBLE.
Linked PRs
The text was updated successfully, but these errors were encountered: