-
-
Notifications
You must be signed in to change notification settings - Fork 33.2k
Docs: Fix typos in documentation files #125569
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1984,7 +1984,7 @@ Haubenwallner. | |
.. nonce: CLz6qy | ||
.. section: Build | ||
|
||
Rename --with-optimiations to --enable-optimizations. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you check the Git log to see if this renaming was an actual configure flag spelling bugfix? Ditto for the 3.6 and 3.7 NEWS rst files. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm wondering if it makes sense at all to go back through old versions and correct typos. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah. There is a risk of introducing documentation errors and inconsistencies with such changes. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can start with the second question here from @willingc. That's my question to you. I included the changes in history files to showcase but I don't know if it should be included. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @erlend-aasland I think #125569 (review) is how we should approach typo PRs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. FWIW the spelling fix is appropriate. This is the original commit in 3.5: https://hg.python.org/cpython/rev/c0ea81315fb6 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I know, and for such cases it is helpful to include this Git archeology in the description of the PR, for the convenience of the reviewer. |
||
Rename --with-optimizations to --enable-optimizations. | ||
|
||
.. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with your previous fix. C is closer to X than S on my keyboard. The examples are the doc-tests, embedded in the text.