Skip to content
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

bpo-28851: DOC: Retrofit changes to collections.rst from 2.7 #1274

Merged
merged 1 commit into from
Apr 25, 2017

Conversation

csabella
Copy link
Contributor

Notes from the original change in 2.7:

Minor doc clean-up.

  • Show list of fields option before showing the single string alternative.
  • Remove the PS2 prompts so that the examples become cut-and-pastable.

@mention-bot
Copy link

@csabella, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @rhettinger and @tiran to be potential reviewers.

@vadmium
Copy link
Member

vadmium commented Apr 24, 2017

This changes things unrelated to field_names, some of which were already made in revision 15aded8 and recently undone: https://bugs.python.org/issue27205. Did you try running the doc tests? If we cannot agree on the best way to mark up example code, I suggest to leave it as it is. Otherwise, it would be good to negotiate with the doc test bug or the people involved: @JelleZijlstra, @marco-buttu.

@csabella
Copy link
Contributor Author

I ran './python -m test' and test_collections passed, but maybe that's not the test you mean? The bug ticket for 28851 didn't mention the other issue, so I thought it just needed to be retrofitted from that older revision into the newest docs.

@JelleZijlstra
Copy link
Member

I think Martin was referring to doctests, which you can run by running make doctest in the Doc/ subdirectory.

@JelleZijlstra
Copy link
Member

Otherwise I'm not familiar with the linked changes, but it seems better to drop unrelated modifications from this PR.

@serhiy-storchaka
Copy link
Member

Please restore the PS2 prompts. The examples are cut-and-pastable, just press on the button at right top corner of an example box.

@csabella
Copy link
Contributor Author

OK. I copied and pasted the comments from the original PR by RH, so he had made the bullet about them not being able to be cut and pasted. But, thank you for clarifying for me. This is all a learning experience and I appreciate everyone's patience. And thank you for telling me about 'make doctest'.

@serhiy-storchaka serhiy-storchaka added the docs Documentation in the Doc dir label Apr 25, 2017
@Mariatta Mariatta merged commit 97bf722 into python:master Apr 25, 2017
Mariatta pushed a commit to Mariatta/cpython that referenced this pull request Apr 26, 2017
Clarify that a sequence of strings is the preferred value for 'field_names'.
(cherry picked from commit 97bf722)
Mariatta added a commit that referenced this pull request Apr 26, 2017
Clarify that a sequence of strings is the preferred value for 'field_names'.
(cherry picked from commit 97bf722)
@csabella csabella deleted the bpo28851 branch April 26, 2017 09:42
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants