Skip to content

bpo-33431: Change description about doc in programming, faq.#6706

Closed
lyu-huiyang wants to merge 4 commits intopython:masterfrom
lyu-huiyang:patch-1
Closed

bpo-33431: Change description about doc in programming, faq.#6706
lyu-huiyang wants to merge 4 commits intopython:masterfrom
lyu-huiyang:patch-1

Conversation

@lyu-huiyang
Copy link
Copy Markdown

@lyu-huiyang lyu-huiyang commented May 5, 2018

I think the description and in all cases in the standard library is not good. The method pop() that mutates an object will not return None .

https://bugs.python.org/issue33431

The description `and in all cases in the standard library` is not good.
@the-knights-who-say-ni
Copy link
Copy Markdown

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).

Unfortunately our records indicate you have not signed the 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.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

Change description about programming.
Change description about programming, faq
@lyu-huiyang
Copy link
Copy Markdown
Author

CLA has signed.

@JulienPalard
Copy link
Copy Markdown
Member

Hi @lvhuiyang, thanks for contributing and welcome!

The CLA may take some time to be validated don't worry.

About your modification, as it's in an already long answer about a broader subject, I would go toward simplifying the paragraph (removing things) instead of complexifying it. Why not simply removing the (and in all cases in the standard library)?

For small documentation changes like this, next time it would be OK not to add a news entry
And for this one, imagine being someone reading the news and reading "Change description about programming, faq for https://docs.python.org/3/", what would you learn about the modification?
Maybe something like "Removed wrong statement in programming faq" would be clearer for the reader?

@lyu-huiyang
Copy link
Copy Markdown
Author

@JulienPalard Thank you for your reply, I agree with you about simplifying the paragraph. And I changed the news entry to be clearer.

I has submited a comment again. So this is a so small modification, if this PR is not necessary I will close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants