summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2013-08-10 12:57:27 (GMT)
committerEli Bendersky <eliben@gmail.com>2013-08-10 12:57:27 (GMT)
commit43694a50ab5f0083d8d252018739caf2cf4f08d5 (patch)
treeebba71ecf66cf152990de582d26029881f7ef715
parentfb1a7bc907021a57d9556c52f762f101eb55b5c1 (diff)
downloadcpython-43694a50ab5f0083d8d252018739caf2cf4f08d5.zip
cpython-43694a50ab5f0083d8d252018739caf2cf4f08d5.tar.gz
cpython-43694a50ab5f0083d8d252018739caf2cf4f08d5.tar.bz2
Issue #18668: Further clarify m_size setting for non-negative values
-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 745b396..e80e0ea 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -191,10 +191,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.