◐ Shell
reader mode source ↗
Skip to content

gh-106446: Fix failed doctest in stdtypes#106447

Merged
terryjreedy merged 10 commits into
python:mainfrom
CharlieZhao95:doc/fix_stdtypes_doctest
Jul 14, 2023
Merged

gh-106446: Fix failed doctest in stdtypes#106447
terryjreedy merged 10 commits into
python:mainfrom
CharlieZhao95:doc/fix_stdtypes_doctest

Conversation

@CharlieZhao95

@CharlieZhao95 CharlieZhao95 commented Jul 5, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fix failed doctest in stdtypes.

📚 Documentation preview 📚: https://cpython-previews--106447.org.readthedocs.build/

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 5, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jul 5, 2023
Closed
terryjreedy
terryjreedy requested changes Jul 6, 2023
View reviewed changes

@terryjreedy terryjreedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

More of the doctests definitely need changes, regardless of CI issues. See issue comment.

@bedevere-bot

bedevere-bot commented Jul 6, 2023

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@CharlieZhao95

CharlieZhao95 commented Jul 6, 2023

Copy link
Copy Markdown
Contributor Author

More of the doctests definitely need changes, regardless of CI issues. See issue comment.

Should I put all fixes in one PR? These changes may need to be backported to different Python versions :)

@terryjreedy

terryjreedy commented Jul 9, 2023

Copy link
Copy Markdown
Member

That is why I checked the output back to 3.11. I believe everything was same back to 3.11. So 'yes'.

@CharlieZhao95 CharlieZhao95 changed the title gh-106446: Fix failed doctest in Integer string conversion length limitation Jul 11, 2023
terryjreedy
terryjreedy approved these changes Jul 13, 2023
View reviewed changes

@terryjreedy terryjreedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thank you for the additions. They look good. I am not going to touch the address issue now.
I added "Note that all byte lengths may depend on the operating system." so that readers will not be puzzled if they run those examples, or doctest them, on Windows. I am ready to merge once you approve the new sentence.

@CharlieZhao95

CharlieZhao95 commented Jul 14, 2023

Copy link
Copy Markdown
Contributor Author

Thanks. This change looks good to me, please merge :) @terryjreedy

@terryjreedy terryjreedy merged commit 89867d2 into python:main Jul 14, 2023
@miss-islington

miss-islington commented Jul 14, 2023

Copy link
Copy Markdown
Contributor

Thanks @CharlieZhao95 for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Jul 14, 2023

Copy link
Copy Markdown
Contributor

Sorry, @CharlieZhao95 and @terryjreedy, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 89867d2491c0c3ef77bc237899b2f0762f43c03c 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 14, 2023
@CharlieZhao95 @miss-islington
pythongh-106446: Fix failed doctest in stdtypes (pythonGH-106447) …
dd31871 
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 89867d2)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
@bedevere-bot

bedevere-bot commented Jul 14, 2023

Copy link
Copy Markdown

GH-106741 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 14, 2023
@CharlieZhao95

This comment was marked as resolved.

Sign in to view
terryjreedy added a commit to terryjreedy/cpython that referenced this pull request Jul 14, 2023
@terryjreedy
pythongh-106446: Fix failed doctest in stdtypes (python#106447) …
87ba4cf 
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

(cherry picked from commit 89867d2)
terryjreedy added a commit to terryjreedy/cpython that referenced this pull request Jul 14, 2023
@terryjreedy @CharlieZhao95
[3.11] pythongh-106446: Fix failed doctest in stdtypes (pythonGH-106447) …
f1359be 
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>.
(cherry picked from commit 89867d2)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
@bedevere-bot

bedevere-bot commented Jul 14, 2023

Copy link
Copy Markdown

GH-106742 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 14, 2023
terryjreedy added a commit that referenced this pull request Jul 14, 2023
@miss-islington @CharlieZhao95 @terryjreedy
[3.12] gh-106446: Fix failed doctest in stdtypes (GH-106447) (#106741) …
00eb435 
(cherry picked from commit 89867d2)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
terryjreedy added a commit that referenced this pull request Jul 14, 2023
@terryjreedy @CharlieZhao95
[3.11] gh-106446: Fix failed doctest in stdtypes (GH-106447) (#106742) …
2186212 
(cherry picked from commit 89867d2)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
kgdiem pushed a commit to kgdiem/cpython that referenced this pull request Jul 14, 2023
@CharlieZhao95 @terryjreedy @kgdiem
pythongh-106446: Fix failed doctest in stdtypes (python#106447) …
2dd5049 
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@terryjreedy terryjreedy terryjreedy approved these changes

Assignees

@terryjreedy terryjreedy

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CharlieZhao95 @bedevere-bot @terryjreedy @miss-islington