Description

TizzySaurus

opened on Jan 2, 2021

Issue body actions

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.

Activity

1. TizzySaurus

   changed the title [-]Print documentation has `end` kwarg escaped[/-] [+]Python escape codes (\n, \t etc.) are missing the '\'[/+] on Jan 2, 2021
2. 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[/+] on Jan 2, 2021
3. JulienPalard commented on Jan 3, 2021

   

   JulienPalard

   on Jan 3, 2021

   Member

   More actions

   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.
4. JulienPalard commented on Jan 4, 2021

   

   JulienPalard

   on Jan 4, 2021

   Member

   More actions

   @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!
5. JulienPalard

   closed this as completedon Jan 4, 2021

Issue actions