Skip to content

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

Merged
merged 4 commits into from
Jul 16, 2019
Merged

Conversation

sgalal
Copy link
Contributor

@sgalal sgalal commented Jul 15, 2019

In current Python document (3.7 - 3.9) there is such statement in documentation of Integer Objects:

The current implementation keeps an array of integer objects for all integers between -5 and 256, when you create an int in that range you actually just get back a reference to the existing object. So it should be possible to change the value of 1. I suspect the behaviour of Python in this case is undefined. :-)

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.

@the-knights-who-say-ni
Copy link

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
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

Copy link
Contributor

@aeros aeros left a 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.

@aeros
Copy link
Contributor

aeros commented Jul 16, 2019

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.

sgalal and others added 3 commits July 15, 2019 22:39
A sentence starting with "So it should be possible..." shouldn't be in the docs either.

Co-Authored-By: Kyle Stanley <[email protected]>
@aeros
Copy link
Contributor

aeros commented Jul 16, 2019

The latest build error from travis wasn't particularly helpful:

nntplib.NNTPTemporaryError: 400 load at 16.92, try later

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:

just get back a reference to the existing object.
to
just get back a reference to the existing object .

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.

@aeros
Copy link
Contributor

aeros commented Jul 16, 2019

If running the tests again doesn't work, another good way to troubleshoot the doc tests is to use the patchcheck utility, see the devguide for more information. This will attempt to automatically correct any whitespace issues. I usually use it as the final step before submitting any PRs.

@bedevere-bot
Copy link

@rhettinger: Please replace # with GH- in the commit message next time. Thanks!

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
…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
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants