PEP 680: Format rst/PEP and copyedit for grammar, clarity & phrasing #2233
Conversation
pep-0680.rst
Outdated
| /, | ||
| *, | ||
| parse_float: Callable[[str], Any] = ..., | ||
| ) -> dict[str, Any]: ... |
There was a problem hiding this comment.
| ) -> dict[str, Any]: ... | |
| ) -> dict[str, Any]: ... |
There was a problem hiding this comment.
Oops, somehow missed that one, thanks. Fixed.
pep-0680.rst
Outdated
| `changelog <https://github.com/toml-lang/toml/blob/master/CHANGELOG.md>`_, we | ||
| see TOML has had no major changes since April 2020 and has had two releases in | ||
| the last five years. | ||
| The release of TOML 1.0 in January 2021 indicates the TOML format should |
There was a problem hiding this comment.
| The release of TOML 1.0 in January 2021 indicates the TOML format should | |
| The release of TOML 1.0.0 in January 2021 indicates the TOML format should |
The release is actually 1.0.0. Not sure how important detail this is. Also if we want to refer to the major version (>=1,<2) then maybe use v1?
Thanks for the PR, by the way, this is great! 😃
There was a problem hiding this comment.
I was just drawing on my experience for which sounded the most idiomatic, what was generally used on the TOML spec repo, and the fact that "TOML 1.0" indicated approximately the correct degree of version precision for most usages, but you're right that it isn't strictly correct. To address this, I changed usages (like this one) that referred to the specific version to 1.0.0, and to the 1.x major version series in general to 1.x.
Pinging @pradyunsg in case you have any further input here before this gets merged
There was a problem hiding this comment.
What you've done sounds about right to me.
I'll likely be cutting 1.0.1 at some point this year, so... there's that. :)
|
Pleas at-mention a pep editor when you need help merging. |
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Co-authored-by: Taneli Hukkinen <3275109+hukkin@users.noreply.github.com>
|
@hukkin @hauntsaninja Please re-review! |
|
Looks good to me too, thanks! |
CC: @hauntsaninja @hukkin @encukou @pradyunsg
As requested previously, I performed a copyedit of the text to fix a number of typos and grammar issues, use easy to read, idiomatic, appropriate and precise phrasing, explicitly clarify a number of points, re-order a few parts for more logical flow, avoid repetition, and other improvements. As a separate commit, I also performed some formatting and small textual tweaks per the rst, PEP 1 and PEP 12 conventions, as well as general correctness, consistency and readability. If you don't like any of changes, just let me know and I'm happy to explain them, propose something different, or revert if necessary. Thanks!