-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
Confusing return type in tokenize.untokenize
docs
#129020
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
docs
Documentation in the Doc dir
Comments
AA-Turner
pushed a commit
that referenced
this issue
Jan 20, 2025
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jan 20, 2025
… docs (pythonGH-129021) (cherry picked from commit bca35f0) Co-authored-by: Tomas R. <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jan 20, 2025
… docs (pythonGH-129021) (cherry picked from commit bca35f0) Co-authored-by: Tomas R. <[email protected]>
srinivasreddy
pushed a commit
to srinivasreddy/cpython
that referenced
this issue
Jan 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation
The docs for tokenize.untokenize are somewhat confusing
regarding the return type of the function. The second paragraphs says:
while the third paragraph clarifies that it can be both str and bytes:
cpython/Doc/library/tokenize.rst
Lines 100 to 102 in 6c52ada
I think we should remove the first sentence (
The reconstructed script is returned as a single string.
)because it's wrong and if someone is just skimming the docs they might not realize that the full
explanation is only in the next paragraph.
Linked PRs
tokenize.untokenize
docs #129021tokenize.untokenize
docs (GH-129021) #129035tokenize.untokenize
docs (GH-129021) #129036The text was updated successfully, but these errors were encountered: