[issue45393] help() on operator precedence has confusing entries "await" "x" and "not" "x"
Zachary Ware
report at bugs.python.org
Thu Oct 7 10:00:00 EDT 2021
Zachary Ware <zachary.ware at gmail.com> added the comment:
Correct; 3.7 and 3.8 are both in security-fix-only maintenance mode; their documentation is no longer updated unless a security-related fix causes a significant change in behavior that needs to be documented.
As far as fixing this issue, we have a few options. The cause is that the source for these rows looks like ':keyword:`await` ``x``', which basically produces two inline code blocks with a non-code space between, which the pydoc-topics renderer renders as two separately quoted words.
Option 1: Replace ':keyword:`await` ``x``' with `:keyword:`await x <await>`. This keeps the link to the `await` anchor, but extends it across the ' x' bit. The pydoc rendering is '"await x"'.
Option 2: Replace ':keyword:`await` ``x``' with '``await x``. This also gives the pydoc rendering of '"await x"', but loses the link to the `await` anchor, which I would rather not do.
Option 3: As option 2, but also replace 'Await' in the description column with a link to the `await` anchor. This breaks from how other keywords in the table are linked.
Option 4: Adjust the pydoc-topics renderer to smush together consecutive inline code blocks. This might cause some issues elsewhere.
----------
nosy: +zach.ware
versions: -Python 3.7, Python 3.8
_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue45393>
_______________________________________
More information about the Python-bugs-list
mailing list