Skip to content

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

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

Merged
ericsnowcurrently merged 43 commits into from
Jun 14, 2018
Merged

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

Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
27612d1
Improve C-API doc for PyTypeObject.
ericsnowcurrently Jun 4, 2018
04b4852
Fix up the quick reference table.
ericsnowcurrently Jun 5, 2018
e1aced8
Avoid accidental bold.
ericsnowcurrently Jun 5, 2018
337c932
Fix typos.
ericsnowcurrently Jun 5, 2018
af5733d
Add markup for NULL.
ericsnowcurrently Jun 5, 2018
4c923e8
Add markup for __dict__.
ericsnowcurrently Jun 5, 2018
3dbba8c
Add markup in the typedefs table.
ericsnowcurrently Jun 5, 2018
490b6ab
Add missing markup.
ericsnowcurrently Jun 5, 2018
ea81fc2
Do not worry about tp_del.
ericsnowcurrently Jun 5, 2018
0e591e6
Fix inheritance for tp_as_async.
ericsnowcurrently Jun 5, 2018
46233dc
Fix inheritance for tp_hash.
ericsnowcurrently Jun 5, 2018
414448f
Clarify tp_hash when NULL.
ericsnowcurrently Jun 5, 2018
356012d
Do not refer to _Py_HashPointer.
ericsnowcurrently Jun 5, 2018
f4d6500
Drop duplicate info about PyGetSetDef.
ericsnowcurrently Jun 5, 2018
a3021d1
Fix the anchor for tp_as_async.
ericsnowcurrently Jun 6, 2018
39a19c8
Move the quick-ref table legend up below the table.
ericsnowcurrently Jun 6, 2018
305468b
Add links to typedef names in the summary table.
ericsnowcurrently Jun 6, 2018
221181c
Move the slot typedefs table to the quick reference section.
ericsnowcurrently Jun 6, 2018
c35b627
Fix the table of contents.
ericsnowcurrently Jun 6, 2018
6759ac7
Add more "info" columns to the tp slots table.
ericsnowcurrently Jun 6, 2018
e4994d3
tp_finalize is not internal-only.
ericsnowcurrently Jun 6, 2018
cd276bd
Fix table info and add columns.
ericsnowcurrently Jun 6, 2018
df5f9ae
Fix table column widths.
ericsnowcurrently Jun 6, 2018
ce81b38
Fix the note about inheritance through attr lookup.
ericsnowcurrently Jun 6, 2018
5264f37
Add a placeholder for common cases in the quick ref.
ericsnowcurrently Jun 6, 2018
7f66703
Stub out the type slot typedefs.
ericsnowcurrently Jun 6, 2018
7ba9e24
Add the missing type slot descriptions.
ericsnowcurrently Jun 6, 2018
8ad1cbe
Drop the "Default" section from type slots that do not need it.
ericsnowcurrently Jun 6, 2018
95af724
Add a column for corresponding special method names.
ericsnowcurrently Jun 6, 2018
bbbbae0
Add a table for the "sub-slots".
ericsnowcurrently Jun 6, 2018
c67b704
minor cleanup
ericsnowcurrently Jun 6, 2018
3b7c312
Fill out the slot typedef descriptions.
ericsnowcurrently Jun 7, 2018
00852e5
Drop trailing parens in pseudo-call.
ericsnowcurrently Jun 7, 2018
9d02687
Do not use a ref in a code block.
ericsnowcurrently Jun 7, 2018
71dfb1d
Add a NEWS entry.
ericsnowcurrently Jun 7, 2018
3d74a2c
Add examples.
ericsnowcurrently Jun 8, 2018
c30dec3
Move the examples to the bottom.
ericsnowcurrently Jun 8, 2018
ae3ad3d
Add a section about heap types.
ericsnowcurrently Jun 8, 2018
349e245
Add a note about tp_base initialization.
ericsnowcurrently Jun 8, 2018
cef58ea
Use a better convention for required type slots in the table.
ericsnowcurrently Jun 13, 2018
6af25b7
Use less confusing phrasing in the table legend.
ericsnowcurrently Jun 13, 2018
8d685e7
Fix accidental upper-cases.
ericsnowcurrently Jun 13, 2018
f2df61d
Use less awkward working for the tp_richcompare default.
ericsnowcurrently Jun 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add missing markup.
  • Loading branch information
@ericsnowcurrently
ericsnowcurrently committed Jun 5, 2018
commit 490b6abb7f6f629b1822512bf629cc7eac0339a7
9 changes: 5 additions & 4 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,9 +940,10 @@ value, that section is omitted.

**Default:**

PyBaseObject_Type provides a tp_richcompare. However, if only
:attr:`tp_hash` is defined, not even this is used and instances
of the type will not be able to participate in any comparisons.
:c:type:`PyBaseObject_Type` provides a :attr:`tp_richcompare`.

@vadmium vadmium Jun 9, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Drop a or add a real noun, i.e. “provides tp_richcompare” or “provides a tp_richcompare implementation”

@ericsnowcurrently ericsnowcurrently Jun 13, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

agreed

However, if only :attr:`tp_hash` is defined, not even this is used
and instances of the type will not be able to participate in any
comparisons.

The following macro is defined to ease writing rich comparison functions:

Expand Down Expand Up @@ -1317,7 +1318,7 @@ value, that section is omitted.
:c:func:`PyType_GenericAlloc`, to force a standard heap
allocation strategy.

For static subtypes, PyBaseObject_Type uses
For static subtypes, :c:type:`PyBaseObject_Type` uses
:c:func:`PyType_GenericAlloc`. That is the recommended value
for all statically defined types.

Expand Down