summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Bradshaw <robertwb@gmail.com>2018-10-02 11:59:06 +0200
committerRobert Bradshaw <robertwb@gmail.com>2018-10-02 11:59:06 +0200
commitfbd2fd09d099f51db44c28a768812758222b9208 (patch)
tree2553ba4744ea01aa772d3ea26340122e8e95ffa7 /docs
parentc9eda12b4806fba3931f7b791be7a672c92d9ca0 (diff)
downloadcython-fbd2fd09d099f51db44c28a768812758222b9208.tar.gz
Rename check_size extend option to ignore.
Diffstat (limited to 'docs')
-rw-r--r--docs/src/userguide/extension_types.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/src/userguide/extension_types.rst b/docs/src/userguide/extension_types.rst
index b9cf890fb..63b407871 100644
--- a/docs/src/userguide/extension_types.rst
+++ b/docs/src/userguide/extension_types.rst
@@ -771,11 +771,11 @@ Where:
- ``object_struct_name`` is the name to assume for the type's C struct.
- ``type_object_name`` is the name to assume for the type's statically
declared type object.
-- ``cs_option`` is ``warn`` (the default), ``error``, or ``extend`` and is only
+- ``cs_option`` is ``warn`` (the default), ``error``, or ``ignore`` and is only
used for external extension types. If ``error``, the ``sizeof(object_struct)``
that was found at compile time must match the type's runtime ``tp_basicsize``
exactly, otherwise the module import will fail with an error. If ``warn``
- or ``extend``, the ``object_struct`` is allowed to be smaller than the type's
+ or ``ignore``, the ``object_struct`` is allowed to be smaller than the type's
``tp_basicsize``, which indicates the runtime type may be part of an updated
module, and that the external module's developers extended the object in a
backward-compatible fashion (only adding new fields to the end of the object).