◐ Shell
reader mode source ↗
Skip to content

bpo-17045: Improve C-API doc for PyTypeObject.#7413

Merged
ericsnowcurrently merged 43 commits into
python:masterfrom
ericsnowcurrently:typeobj-doc
Jun 14, 2018
Merged

bpo-17045: Improve C-API doc for PyTypeObject.#7413
ericsnowcurrently merged 43 commits into
python:masterfrom
ericsnowcurrently:typeobj-doc

Conversation

@ericsnowcurrently

@ericsnowcurrently ericsnowcurrently commented Jun 5, 2018 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

This is a quick port to git of a patch I wrote for the issue several years ago. I'm sure I have it mostly okay, but haven't had time yet to check it closely.

https://bugs.python.org/issue17045

@ericsnowcurrently ericsnowcurrently added the docs Documentation in the Doc dir label Jun 5, 2018
serhiy-storchaka
serhiy-storchaka reviewed Jun 5, 2018
View reviewed changes
8 hidden conversations Load more…
@serhiy-storchaka

serhiy-storchaka commented Jun 5, 2018

Copy link
Copy Markdown
Member

I'm not sure about usefulness of Default: notes. If the slot is inherited, then the default is the parent's value. It looks to me that Inheritane: notes cover this, and Default: notes don't add new information.

@ericsnowcurrently

ericsnowcurrently commented Jun 5, 2018

Copy link
Copy Markdown
Member Author

If I recall correctly, there are a few slots with defaults. Would it be better to omit the "default" section in the rest of the cases? FWIW, I added the "default" section because the defaults aren't always clear.

34 hidden items Load more…
@ericsnowcurrently

ericsnowcurrently commented Jun 7, 2018

Copy link
Copy Markdown
Member Author

Ah, I need to run "make suspicious". :/

@ericsnowcurrently

ericsnowcurrently commented Jun 13, 2018

Copy link
Copy Markdown
Member Author

I've addressed all review comments.

@ericsnowcurrently ericsnowcurrently merged commit 9e7c921 into python:master Jun 14, 2018
@ericsnowcurrently ericsnowcurrently deleted the typeobj-doc branch June 14, 2018 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vadmium vadmium vadmium left review comments

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments

@csabella csabella csabella left review comments

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ericsnowcurrently @serhiy-storchaka @vadmium @csabella @the-knights-who-say-ni @bedevere-bot