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.

Sign up for GitHub

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

Jump to bottom

bpo-30059: Py_Ellipsis in C API documentation #1018

Merged
merged 3 commits into from
Apr 14, 2017
Merged

bpo-30059: Py_Ellipsis in C API documentation #1018

merged 3 commits into from
Apr 14, 2017

Conversation

MSeifert04
Copy link
Contributor

@MSeifert04 MSeifert04 commented Apr 6, 2017 •
edited
Loading

As far as I have seen there is no mention of it anywhere. And it's defined along with sliceobject so I included it in the documentation there. FWIW: most of the added documentation is copied from Py_None.

@mention-bot
Copy link

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

ashemedai
ashemedai approved these changes Apr 7, 2017
View reviewed changes
Copy link
Contributor

@ashemedai ashemedai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to have it documented.

Maybe add details from something like http://stackoverflow.com/a/773472/276047 to explain just what it is for?

@MSeifert04
Copy link
Contributor Author

@ashemedai Thank you for the feedback.

But I don't think the C API would be the best place to explain what it is for. Shouldn't that rather be explained and documented in constants.Ellipsis?

@ashemedai
Copy link
Contributor

@MSeifert04 Good point. It's been a while since I looked through the entirety of the documentation. You might be right there, yes.

@MSeifert04 MSeifert04 changed the title Py_Ellipsis in C API documentation bpo-30059: Py_Ellipsis in C API documentation Apr 12, 2017
@serhiy-storchaka serhiy-storchaka self-requested a review April 12, 2017 19:01
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir needs backport to 2.7 labels Apr 12, 2017
serhiy-storchaka
serhiy-storchaka reviewed Apr 14, 2017
View reviewed changes
Doc/c-api/slice.rst Outdated
@@ -1,5 +1,16 @@
.. highlightlang:: c

Ellipsis Object
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the file is called slice.rst and slices are more used than Ellipsis I think Slice Objects should be before Ellipsis Object.

@serhiy-storchaka serhiy-storchaka merged commit 0dc5c31 into python:master Apr 14, 2017
Mariatta pushed a commit that referenced this pull request Apr 15, 2017
@MSeifert04 @Mariatta
[3.6] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (…
05bfbcd 
…GH-1149)
Mariatta pushed a commit that referenced this pull request Apr 15, 2017
@MSeifert04 @Mariatta
[2.7] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (…
0b46fcf 
…GH-1147)
Mariatta pushed a commit that referenced this pull request Apr 15, 2017
@MSeifert04 @Mariatta
[3.5] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (…
f40e72d 
…GH-1148)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashemedai ashemedai ashemedai approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@MSeifert04 @mention-bot @ashemedai @serhiy-storchaka @Mariatta @the-knights-who-say-ni