bpo-28415: Note 0 conversion different between Python and C#885
bpo-28415: Note 0 conversion different between Python and C#885zhangyangyu merged 6 commits intopython:masterfrom louisom:change_doc_28415
Conversation
|
@grapherd, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @serhiy-storchaka and @benjaminp to be potential reviewers. |
zhangyangyu
left a comment
zhangyangyu
left a comment
There was a problem hiding this comment.
I think instead of a .. note::, it's better to follow the style of the table in https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting since we may find more exceptions in future. And I think the examples are not needed.
zhangyangyu
added
docs
|
Too much words for minor difference. |
|
@zhangyangyu @serhiy-storchaka After reference the description from cpp - printf, simplify the note about it. |
|
Actually I prefer the previous wording:
It's more direct to me and the current wording gives a feeling that the precision won't take effects at all. :-( |
|
See comment on https://bugs.python.org/issue28415 for minimal and terse alternatives. Build error will disappear with either suggestion. |
terryjreedy
left a comment
terryjreedy
left a comment
There was a problem hiding this comment.
See link to issue in comment
|
Just adding the two notes will suffice. I don't think readers are helped at all by changing "exactly" to "nearly" over such a minor distinction. The word "nearly" creates an unnecessary sense of risk and uncertainty in the minds of readers. Also, I think this is so unimportant that it shouldn't be backported. |
terryjreedy
left a comment
terryjreedy
left a comment
There was a problem hiding this comment.
The proposed addition is not proper English. I give a different version on the issue. I also think 'exactly' should just be removed when not exactly true, but will not push for that.
Doc/c-api/bytes.rst
Outdated
| +-------------------+---------------+--------------------------------+ | ||
| | :attr:`%d` | int | Exactly equivalent to | | ||
| | :attr:`%d` | int | Nearly equivalent to | | ||
| | | | ``printf("%d")``. | |
There was a problem hiding this comment.
Please add a reference to the note, like (1).
I would prefer to remove Nearly/Exactly. I don't think that the subtle difference is major enough to justify a "Nearly".
There was a problem hiding this comment.
So we agree dropping 'exactly' when not exactly true.
Doc/c-api/unicode.rst
Outdated
| | | | represented as a C int. | | ||
| +-------------------+---------------------+--------------------------------+ | ||
| | :attr:`%d` | int | Exactly equivalent to | | ||
| | :attr:`%d` | int | Nearly equivalent to | |
|
@terryjreedy, @Haypo, @zhangyangyu, could you help for review the latest addressed? |
|
Replacing the original 'Exactly' with a note marker looks good to me. I cannot apply patch to test generated html for correct formatting, but assuming you have, I approve net result. |
|
I put down the unicode footnote under the original note block |
|
Thanks @lulouie ! This style looks good and is actually what I mean at first. |
8 participants
No description provided.