From: Petr Viktorin <encukou@gmail.com>
Date: Thu, 23 May 2024 22:11:45 +0000 (+0200)
Subject: Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409)
X-Git-Tag: v3.14.0a1~1784
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ffa24aab107b5bc3c6ad31a6a245c226bf24b208;p=thirdparty%2FPython%2Fcpython.git

Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409)
---

diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst
index cec9a6cef4bf..834ab2536e6c 100644
--- a/Doc/library/base64.rst
+++ b/Doc/library/base64.rst
@@ -193,7 +193,7 @@ The modern interface provides:
 
    *wrapcol* controls whether the output should have newline (``b'\n'``)
    characters added to it. If this is non-zero, each output line will be
-   at most this many characters long.
+   at most this many characters long, excluding the trailing newline.
 
    *pad* controls whether the input is padded to a multiple of 4
    before encoding. Note that the ``btoa`` implementation always pads.
diff --git a/Lib/base64.py b/Lib/base64.py
index 25164d1a1df4..5a7e790a1933 100755
--- a/Lib/base64.py
+++ b/Lib/base64.py
@@ -332,7 +332,7 @@ def a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False):
 
     wrapcol controls whether the output should have newline (b'\\n') characters
     added to it. If this is non-zero, each output line will be at most this
-    many characters long.
+    many characters long, excluding the trailing newline.
 
     pad controls whether the input is padded to a multiple of 4 before
     encoding. Note that the btoa implementation always pads.