turtle.write doc missing tuple parens for font default in 3.10+

[jggammon]

BPO	45397
Nosy	@birkenfeld, @terryjreedy, @serhiy-storchaka

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-10-07.03:12:17.930>
labels = ['3.11', 'type-bug', '3.10', 'docs']
title = 'turtle.write doc missing tuple parens for font default in 3.10+'
updated_at = <Date 2021-11-27.02:54:27.094>
user = 'https://bugs.python.org/jggammon'

bugs.python.org fields:

activity = <Date 2021-11-27.02:54:27.094>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-10-07.03:12:17.930>
creator = 'jggammon'
dependencies = []
files = []
hgrepos = []
issue_num = 45397
keywords = []
message_count = 7.0
messages = ['403348', '403351', '403352', '403413', '403415', '403416', '407128']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'terry.reedy', 'docs@python', 'serhiy.storchaka', 'jggammon']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue45397'
versions = ['Python 3.10', 'Python 3.11']

[jggammon]

In the version 3.10 and 3.11 python turtle doc, the turtle.write line shows font without it's tuple parenthesis. Something change in 3.10 that makes it look like font='Arial' and 8 and 'normal' are 3 separate parameters, when it should be one tuple parameter font=(x,y,z).

Ex. of wrong entry (URL=https://docs.python.org/3.11/library/turtle.html#turtle.write)
line=turtle.write(arg, move=False, align='left', font='Arial', 8, 'normal')

Ex. of correct entry (https://docs.python.org/3.9/library/turtle.html#turtle.write)
line=turtle.write(arg, move=False, align="left", font=("Arial", 8, "normal"))

[serhiy-storchaka]

This looks like some Sphinx bug.

In Python 3.8, using Sphinx:

>>> from sphinx.pycode import ast
>>> ast.unparse(ast.parse("('Arial', 8, 'normal')", 'eval').body)
"'Arial', 8, 'normal'"

For comparison, using builtin ast module in Python 3.9:

>>> import ast
>>> ast.unparse(ast.parse("('Arial', 8, 'normal')", 'eval').body)
"('Arial', 8, 'normal')"

[serhiy-storchaka]

Seems it was fixed in Sphinx a year ago: sphinx-doc/sphinx#8265. Maybe we need to update the Sphinx version (but it can introduce new incompatibilities).

[jggammon]

I forgot to mention I'm on Windows 10 PC and see the same thing under Edge and FireFox.

John G. Gammon -. .. .... .. .-.. .- -.. -- .. .-. .- .-. ..

[serhiy-storchaka]

jg, please remove the copy of other message when answer. It makes painfully difficult reading the discussion for visually impaired people.

[serhiy-storchaka]

I tested with Sphinx 1.5.4, and this issue is gone. It introduces a regression with some smart quotes (see sphinx-doc/sphinx#9713), but it is less severe than incorrect rendering of tuples as parameter defaults.

[terryjreedy]

Closed bpo-45872 as duplicate. Éric, any idea for a local fix?

I verified with Sphinx 3.2.1. I tried both escaping with '\' and doubling parens, without success.

[slateny]

Seems fixed in 3.11 but not in 3.10

[terryjreedy]

I verified that in 3.9 and 3.11, turtle.py, line 1098, is now rendered correctly.
.. function:: write(arg, move=False, align="left", font=("Arial", 8, "normal"))
https://docs.python.org/3.11/library/turtle.html#turtle.write
turtle.write(arg, move=False, align='left', font=('Arial', 8, 'normal'))

In 3.10, same line
.. function:: write(arg, move=False, align="left", font=("Arial", 8, "normal"))
renders without the tuple parens.
https://docs.python.org/3.10/library/turtle.html#turtle.write
turtle.write(arg, move=False, align='left', font='Arial', 8, 'normal')

If there is no obvious fix, I think that this should be closed. But...

@JulienPalard Are we using a different version of Sphinx in 3.10 than in 3.9 and 3.11, or is some configuration setting different?

[JulienPalard]

Yes, see docsbuild-scripts' README (but it sometimes lag behind a few days), here's an up-to-date version:

• In 3.9 we use Sphinx==2.4.4
• In 3.10 we use Sphinx==3.2.1
• In 3.11 we use Sphinx==4.5.0

(It can also be checked by looking at the footers.)

[JulienPalard]

Closing this as I see it fixed in /3.8/ to /dev/.