[Python-checkins] bpo-37134: Add PEP570 notation to the documentation (GH-13743)

Carol Willing webhook-mailer at python.org
Wed Jun 5 16:24:32 EDT 2019


https://github.com/python/cpython/commit/54edb04aa688c8247570b4f59b5145e3fa417576
commit: 54edb04aa688c8247570b4f59b5145e3fa417576
branch: master
author: Pablo Galindo <Pablogsal at gmail.com>
committer: Carol Willing <carolcode at willingconsulting.com>
date: 2019-06-05T13:24:28-07:00
summary:

bpo-37134: Add PEP570 notation to the documentation (GH-13743)

files:
M Doc/library/struct.rst
M Doc/library/zlib.rst

diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst
index 1a0fd73c6758..a06d90344ba3 100644
--- a/Doc/library/struct.rst
+++ b/Doc/library/struct.rst
@@ -70,7 +70,7 @@ The module defines the following exception and functions:
    size required by the format, as reflected by :func:`calcsize`.
 
 
-.. function:: unpack_from(format, buffer, offset=0)
+.. function:: unpack_from(format, /, buffer, offset=0)
 
    Unpack from *buffer* starting at position *offset*, according to the format
    string *format*.  The result is a tuple even if it contains exactly one
diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
index aa61278e099a..339acfd0e578 100644
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -47,7 +47,7 @@ The available exception and functions in this module are:
       platforms, use ``adler32(data) & 0xffffffff``.
 
 
-.. function:: compress(data, level=-1)
+.. function:: compress(data, /, level=-1)
 
    Compresses the bytes in *data*, returning a bytes object containing compressed data.
    *level* is an integer from ``0`` to ``9`` or ``-1`` controlling the level of compression;
@@ -132,7 +132,7 @@ The available exception and functions in this module are:
       platforms, use ``crc32(data) & 0xffffffff``.
 
 
-.. function:: decompress(data, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)
+.. function:: decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)
 
    Decompresses the bytes in *data*, returning a bytes object containing the
    uncompressed data.  The *wbits* parameter depends on



More information about the Python-checkins mailing list