Skip to content
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

Closed
egtwobits opened this issue Apr 8, 2023 · 2 comments
Closed

String escape sequences should be listed in the stdtypes page #103360

egtwobits opened this issue Apr 8, 2023 · 2 comments
Labels
docs Documentation in the Doc dir easy

Comments

@egtwobits
Copy link

egtwobits commented Apr 8, 2023

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

@egtwobits egtwobits added the docs Documentation in the Doc dir label Apr 8, 2023
@terryjreedy
Copy link
Member

terryjreedy commented Apr 8, 2023

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.

juswil added a commit to juswil/cpython that referenced this issue Apr 20, 2023
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".
@zormit
Copy link
Contributor

zormit commented Jul 23, 2023

I think this is solved by the PR, but the PR got stale somehow (CI results are outdated by now).

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 2, 2024
…cal_analysis.rst (pythonGH-103638)

(cherry picked from commit d29f57f)

Co-authored-by: Justin Williams <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 2, 2024
…cal_analysis.rst (pythonGH-103638)

(cherry picked from commit d29f57f)

Co-authored-by: Justin Williams <[email protected]>
serhiy-storchaka pushed a commit that referenced this issue Feb 2, 2024
…ical_analysis.rst (GH-103638) (GH-114907)

(cherry picked from commit d29f57f)

Co-authored-by: Justin Williams <[email protected]>
terryjreedy added a commit that referenced this issue Feb 2, 2024
…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]>
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this issue Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Development

No branches or pull requests

4 participants