-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
bpo-37599: Remove a vague statement in documentation of Integer Objects #14786
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
Conversation
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Our records indicate we have not received your CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. If you have recently signed the CLA, please wait at least one business day You can check yourself to see if the CLA has been received. Thanks again for your contribution, we look forward to reviewing it! |
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.
@sgalal Welcome and thanks for the contribution!
I completely agree with the removal of the vague statement. While cleaning up the summary for this function, I would also recommend removing the previous sentence as well. It is also quite vague and doesn't add significant value. A sentence starting with "So it should be possible..." shouldn't be in the docs either.
If you've already submitted your CLA, it's occasionally required to manually update the status on GitHub if it's been over 24 hours. Let me know if you have any questions. |
A sentence starting with "So it should be possible..." shouldn't be in the docs either. Co-Authored-By: Kyle Stanley <[email protected]>
Co-Authored-By: Kyle Stanley <[email protected]>
The latest build error from travis wasn't particularly helpful:
I'd try adding some whitespace the last character of a sentence before the period to trigger the test again (extra whitespace before the period in a sentence won't cause the integration tests to fail). For example, on line 45:
Occasionally the integration tests will fail without having a specific reason. If that doesn't work, one of the core devs can try to help troubleshoot it. I had a similar issue with one of my PRs: #14611. |
If running the tests again doesn't work, another good way to troubleshoot the doc tests is to use the |
@rhettinger: Please replace |
…ts (python#14786) * Remove a vague statement in documentation * Remove another vague sentence A sentence starting with "So it should be possible..." shouldn't be in the docs either. Co-Authored-By: Kyle Stanley <[email protected]> * Include the removal of the previous line Co-Authored-By: Kyle Stanley <[email protected]> * Remove an extra space
…ts (python#14786) * Remove a vague statement in documentation * Remove another vague sentence A sentence starting with "So it should be possible..." shouldn't be in the docs either. Co-Authored-By: Kyle Stanley <[email protected]> * Include the removal of the previous line Co-Authored-By: Kyle Stanley <[email protected]> * Remove an extra space
In current Python document (3.7 - 3.9) there is such statement in documentation of Integer Objects:
The last sentence is vague. It is inappropriate to write "I suspect" in documentation. And as the statements ahead has already clarified the sense that this is "a current implementation", the last sentence should be removed.
https://bugs.python.org/issue37599
https://bugs.python.org/issue37599
Edit: Change "irresponsible" to "inappropriate" to avoid pejoratives, according to https://bugs.python.org/msg348019.