summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2013-08-10 12:58:10 (GMT)
committerEli Bendersky <eliben@gmail.com>2013-08-10 12:58:10 (GMT)
commit562d9cbfe9b11b5bd23810b4ee8a111a8c9aa5b8 (patch)
tree6582bdb716627088cf2a0106d32270b2597178c7 /Doc/c-api
parent8a44c053c17ad52c66836413278569f901f1122a (diff)
parent43694a50ab5f0083d8d252018739caf2cf4f08d5 (diff)
downloadcpython-562d9cbfe9b11b5bd23810b4ee8a111a8c9aa5b8.zip
cpython-562d9cbfe9b11b5bd23810b4ee8a111a8c9aa5b8.tar.gz
cpython-562d9cbfe9b11b5bd23810b4ee8a111a8c9aa5b8.tar.bz2
Issue #18668: Further clarify m_size setting for non-negative values
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/module.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index 92bfd5e..26c4384 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -198,10 +198,10 @@ These functions are usually used in the module initialization function.
freed when the module object is deallocated, after the :c:member:`m_free`
function has been called, if present.
- Setting ``m_size`` to a positive value specifies the size of the additional
- memory required by the module. Setting it to ``-1`` means that the module can
- not be re-initialized because it has global state. Setting it to ``0`` is
- forbidden.
+ Setting ``m_size`` to ``-1`` means that the module can not be
+ re-initialized because it has global state. Setting it to a non-negative
+ value means that the module can be re-initialized and specifies the
+ additional amount of memory it requires for its state.
See :PEP:`3121` for more details.