Issue #18668: Further clarify m_size setting for non-negative values

This commit is contained in:
Eli Bendersky 2013-08-10 05:57:27 -07:00
parent fb1a7bc907
commit 43694a50ab
1 changed files with 4 additions and 4 deletions

View File

@ -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.