Skip to content

gh-101944: mistake in documentation for PyModule_AddObjectRef() #101957

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

Closed
wants to merge 5 commits into from
Closed

gh-101944: mistake in documentation for PyModule_AddObjectRef() #101957

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6f8a756
fix-issue-101944
OTheDev Feb 16, 2023
16c5efa
Try different wording for second sentence
OTheDev Feb 18, 2023
9cc9af3
Different wording
OTheDev Feb 20, 2023
52ecce5
Merge branch 'main' into fix-issue-101944
erlend-aasland Jun 19, 2023
a7b7a73
try different wording after suggestions from review
OTheDev Jun 25, 2023
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
7 changes: 4 additions & 3 deletions Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,10 +449,11 @@ state:
Add an object to *module* as *name*. This is a convenience function which
can be used from the module's initialization function.

On success, return ``0``. On error, raise an exception and return ``-1``.
Copy link
Member

Choose a reason for hiding this comment

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

Please keep this general statement. There are many cases where the function can fail. For example, if mod is not a module or has no dictionary. PyDict_SetItemString() can fail with MemoryError, etc.

On success, return ``0``.

Return ``NULL`` if *value* is ``NULL``. It must be called with an exception
raised in this case.
If *value* is ``NULL`` (indicating failure), raise an exception and return
``-1``. If an exception is set, raise that exception. If no exception is
set, raise :exc:`SystemError`.
Copy link
Member

Choose a reason for hiding this comment

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

This documentation sounds misleading to me. The normal case when value is NULL is that an exception is already set, so the function does not "raise an exception". Also, I dislike documenting the exact exception type for implementation details: please don't document "SystemError".

Copy link
Contributor

Choose a reason for hiding this comment

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

please don't document "SystemError".

That was my fault; I encouraged it in #101957 (comment). Sorry 'bout that!


Example usage::

Expand Down