classification
Title: Missing backslashes in documentation for 3.8 and 3.9
Type: Stage: resolved
Components: Documentation Versions: Python 3.9, Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: mdk Nosy List: adelfino, mdk
Priority: normal Keywords: patch

Created on 2021-01-04 13:03 by mdk, last changed 2021-01-05 08:35 by mdk. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 24093 merged mdk, 2021-01-04 13:03
PR 24092 merged mdk, 2021-01-04 13:04
Messages (1)
msg384324 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2021-01-04 13:03
This is just to track the issue, initially reported here:

https://github.com/python/python-docs-theme/issues/63

Then discussed here:

https://github.com/python/cpython/pull/23827#issuecomment-753598860

Then reverted:

- in 3.8 https://github.com/python/cpython/pull/24093
- in 3.9 https://github.com/python/cpython/pull/24092

I edited the revert to keep only relevant parts, as only a few bits of the commit were causing troubles.

Issue is: Sphinx 2 and Sphinx 3 have incompatible handling of backslahes, fixing them for Sphinx 3 in Python 3.10, then backporting to 3.8 and 3.9 which use Sphinx 2 caused an issue: `\n` for example are rendered as `n`, easy to notice in the documentaion of print:

    print(*objects, sep=' ', end='n', file=sys.stdout, flush=False)ΒΆ

As migration to Sphinx 3 was hard (done for Python 3.10 documentation), it won't be backported to 3.8 and 3.9, which will still be built using Sphinx 2, so some bits had to be reverted for the doc to display the backslash of `\n`.
History
Date User Action Args
2021-01-05 08:35:48mdksetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-01-04 13:04:22mdksetpull_requests: + pull_request22925
2021-01-04 13:03:56mdksetkeywords: + patch
stage: commit review -> patch review
pull_requests: + pull_request22924
2021-01-04 13:03:42mdkcreate