Skip to content

Conversation

@skirpichev
Copy link
Member

No description provided.

@arhadthedev
Copy link
Member

Can confirm that a paragraph don't try to convert a value greater than 255 or you'll get an OverflowError incorrectly has a non-throwing example.

@arhadthedevarhadthedev changed the title Fix typo in the int.to_bytes() docs, now it shows an OverflowErrorFix an incorrect example in the int.to_bytes() docs, now it shows an OverflowErrorFeb 6, 2023
@mdickinson
Copy link
Member

mdickinson commented Feb 6, 2023

I suspect the intent of the example was to support the

The default values can be used to conveniently turn an integer into a single byte object.

statement rather than the

... don't try to convert a value greater than 255 ...

statement.

Maybe @warsaw can confirm or deny?

@skirpichev
Copy link
MemberAuthor

Anyway, across the docs a pattern "don't do this and that or you'll get XYZ:" usually coming with a doctest, where you actually get XYZ...

Maybe we should just drop this example? The text is clear enough.

@skirpichev
Copy link
MemberAuthor

@mdickinson , probably you can decide, nobody else do care.

@mdickinson
Copy link
Member

I don't think the example should be changed here. If we want to reduce confusion, how about just moving things around so that the example immediately follows the "The default values can be used to conveniently turn an integer into a single byte object." statement?

@skirpichev
Copy link
MemberAuthor

If we want to reduce confusion

That was the point.

how about just moving things around

Does make sense for me. See an attempt.

@skirpichevskirpichev changed the title Fix an incorrect example in the int.to_bytes() docs, now it shows an OverflowErrorMove around example in to_bytes() to avoid confusionMar 5, 2023
Copy link
Member

@mdickinsonmdickinson left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

@mdickinsonmdickinson added the needs backport to 3.11 only security fixes label Mar 5, 2023
@mdickinsonmdickinson merged commit 5da379c into python:mainMar 5, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Mar 5, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 5, 2023
Moves an example to be closer to the sentence that refers to it. (cherry picked from commit 5da379c) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
@skirpichevskirpichev deleted the to_bytes-docs branch March 5, 2023 09:40
mdickinson pushed a commit that referenced this pull request Mar 5, 2023
… (#102434) Move around example in to_bytes() to avoid confusion (GH-101595) Moves an example to be closer to the sentence that refers to it. (cherry picked from commit 5da379c) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Mar 6, 2023
Moves an example to be closer to the sentence that refers to it.
carljm added a commit to carljm/cpython that referenced this pull request Mar 6, 2023
* main: (21 commits) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives in sub interpreters module (python#102472) pythongh-95672: Fix versionadded indentation of get_pagesize in test.rst (pythongh-102455) pythongh-102416: Do not memoize incorrectly loop rules in the parser (python#102467) pythonGH-101362: Optimise PurePath(PurePath(...)) (pythonGH-101667) pythonGH-101362: Check pathlib.Path flavour compatibility at import time (pythonGH-101664) pythonGH-101362: Call join() only when >1 argument supplied to pathlib.PurePath() (python#101665) pythongh-102444: Fix minor bugs in `test_typing` highlighted by pyflakes (python#102445) pythonGH-102341: Improve the test function for pow (python#102342) Fix unused classes in a typing test (pythonGH-102437) pythongh-101979: argparse: fix a bug where parentheses in metavar argument of add_argument() were dropped (python#102318) pythongh-102356: Add thrashcan macros to filter object dealloc (python#102426) Move around example in to_bytes() to avoid confusion (python#101595) pythonGH-97546: fix flaky asyncio `test_wait_for_race_condition` test (python#102421) pythongh-96821: Add config option `--with-strict-overflow` (python#96823) pythongh-101992: update pstlib module documentation (python#102133) pythongh-63301: Set exit code when tabnanny CLI exits on error (python#7699) pythongh-101863: Fix wrong comments in EUC-KR codec (pythongh-102417) pythongh-102302 Micro-optimize `inspect.Parameter.__hash__` (python#102303) pythongh-102179: Fix `os.dup2` error reporting for negative fds (python#102180) pythongh-101892: Fix `SystemError` when a callable iterator call exhausts the iterator (python#101896) ...
carljm added a commit to carljm/cpython that referenced this pull request Mar 7, 2023
* main: (37 commits) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives in sub interpreters module (python#102472) pythongh-95672: Fix versionadded indentation of get_pagesize in test.rst (pythongh-102455) pythongh-102416: Do not memoize incorrectly loop rules in the parser (python#102467) pythonGH-101362: Optimise PurePath(PurePath(...)) (pythonGH-101667) pythonGH-101362: Check pathlib.Path flavour compatibility at import time (pythonGH-101664) pythonGH-101362: Call join() only when >1 argument supplied to pathlib.PurePath() (python#101665) pythongh-102444: Fix minor bugs in `test_typing` highlighted by pyflakes (python#102445) pythonGH-102341: Improve the test function for pow (python#102342) Fix unused classes in a typing test (pythonGH-102437) pythongh-101979: argparse: fix a bug where parentheses in metavar argument of add_argument() were dropped (python#102318) pythongh-102356: Add thrashcan macros to filter object dealloc (python#102426) Move around example in to_bytes() to avoid confusion (python#101595) pythonGH-97546: fix flaky asyncio `test_wait_for_race_condition` test (python#102421) pythongh-96821: Add config option `--with-strict-overflow` (python#96823) pythongh-101992: update pstlib module documentation (python#102133) pythongh-63301: Set exit code when tabnanny CLI exits on error (python#7699) pythongh-101863: Fix wrong comments in EUC-KR codec (pythongh-102417) pythongh-102302 Micro-optimize `inspect.Parameter.__hash__` (python#102303) pythongh-102179: Fix `os.dup2` error reporting for negative fds (python#102180) pythongh-101892: Fix `SystemError` when a callable iterator call exhausts the iterator (python#101896) ...
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@skirpichev@arhadthedev@mdickinson@miss-islington@bedevere-bot