summaryrefslogtreecommitdiffstats
path: root/Doc/howto
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2018-07-26 10:22:16 (GMT)
committerGitHub <noreply@github.com>2018-07-26 10:22:16 (GMT)
commit7cb7bcff20a386bba59cbc51e2419542de358bd2 (patch)
treef5d46faf7a7ddd3b427de7de8a74a1fb37fe2993 /Doc/howto
parent323748ad7446c76972c80dbbf510534dc5c22ae8 (diff)
downloadcpython-7cb7bcff20a386bba59cbc51e2419542de358bd2.zip
cpython-7cb7bcff20a386bba59cbc51e2419542de358bd2.tar.gz
cpython-7cb7bcff20a386bba59cbc51e2419542de358bd2.tar.bz2
bpo-20260: Implement non-bitwise unsigned int converters for Argument Clinic. (GH-8434)
Diffstat (limited to 'Doc/howto')
-rw-r--r--Doc/howto/clinic.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/howto/clinic.rst b/Doc/howto/clinic.rst
index 695fbb1..c75c31c 100644
--- a/Doc/howto/clinic.rst
+++ b/Doc/howto/clinic.rst
@@ -878,6 +878,12 @@ converter::
Write a pickled representation of obj to the open file.
[clinic start generated code]*/
+One advantage of real converters is that they're more flexible than legacy
+converters. For example, the ``unsigned_int`` converter (and all the
+``unsigned_`` converters) can be specified without ``bitwise=True``. Their
+default behavior performs range checking on the value, and they won't accept
+negative numbers. You just can't do that with a legacy converter!
+
Argument Clinic will show you all the converters it has
available. For each converter it'll show you all the parameters
it accepts, along with the default value for each parameter.