Skip to content

gh-144257: document return values of PyModule_SetDocString #144258

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
ZeroIntensity merged 4 commits into from
Jan 27, 2026
Merged

gh-144257: document return values of PyModule_SetDocString #144258

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b40979
gh-144257: document return values and failure conditions of PyModule_…
ngoldbaum Jan 26, 2026
f817431
Update module.rst
ngoldbaum Jan 26, 2026
ac313b9
Apply suggestion from @ngoldbaum
ngoldbaum Jan 26, 2026
3d3665e
Apply suggestion from @ngoldbaum
ngoldbaum Jan 26, 2026
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
5 changes: 4 additions & 1 deletion Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,10 @@ or code that creates modules dynamically.
Set the docstring for *module* to *docstring*.
This function is called automatically when creating a module from
``PyModuleDef`` (such as when using :ref:`multi-phase-initialization`,
``PyModule_Create``, or ``PyModule_FromDefAndSpec``).
``PyModule_Create``, or ``PyModule_FromDefAndSpec``). Returns ``0`` on
success and ``-1`` on failure. Failure can happen if creating a Python string
from *docstring* fails or if setting the ``__doc__`` attribute on *module*
fails.
Comment thread
ngoldbaum marked this conversation as resolved.
Outdated

.. versionadded:: 3.5

Expand Down
Loading