Visitar URL original
Python escape codes (\n, \t etc.) are missing the '\' for 3.8 and 3.9 docs · Issue #63 · python/python-docs-theme · GitHub
Skip to content

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

Description

@TizzySaurus

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

  4. JulienPalard commented on Jan 4, 2021

    @JulienPalard
    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions