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

Python escape codes (\n, \t etc.) are missing the '\' for 3.8 and 3.9 docs #63

Closed
TizzySaurus opened this issue Jan 2, 2021 · 2 comments

Comments

@TizzySaurus
Copy link

TizzySaurus commented Jan 2, 2021

I believe this commit (as part of python/cpython#23658) was intended to fix issues with the new way in which sphinx handles backslashes in the Python 3.10 documentation.

The issue is that this commit also applied to the 3.8 and 3.9 documentations, which doesn't have this new handling, and so results in escape codes (\n, \t, etc.) being escaped to just n, t, etc.
E.g. the print documentation has end='n' instead of end='\n'.

I'm guessing the files for the 3.8 and 3.9 docs just need to be reverted back to the files from before this commit.

NB: I'm not sure how the source links to different Python version's docs but the issue only applies to 3.8 and 3.9, not for the docs of Python <3.8 or >3.9.

P.S I've not used GitHub much and this is my first time delving into the python docs source so apologies if I've stated/linked anything incorrectly.

@TizzySaurus TizzySaurus changed the title Print documentation has end kwarg escaped Python escape codes (\n, \t etc.) are missing the '\' Jan 2, 2021
@TizzySaurus TizzySaurus changed the title Python escape codes (\n, \t etc.) are missing the '\' Python escape codes (\n, \t etc.) are missing the '\' for 3.8 and 3.9 docs Jan 2, 2021
@JulienPalard
Copy link
Member

Looks like python/cpython#23658 should have not been backported, thanks for reporting.

I commented on python/cpython#23827 and python/cpython#23828 proposing a revert.

@JulienPalard
Copy link
Member

@TizzySaurus This is in the right way to being fixed, the revert has been done, still have to proofread and merge, then the docsbuild-script will have to build the doc in production for it to update on docs.python.org, it should not take long.

As it's not a theme issue, I'll close this issue, you can keep track of it here now: https://bugs.python.org/issue42822

Again, thanks for reporting, and happy new year!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants