Clarify base64.a85encode docs: *wrapcols* doesn't count the newline

[encukou]

When writing #119406 I noticed the wrapcol docs are unclear; the \n is not counted.
Here's a doc fix.

Another undocumented feature is that negative wrapcol is treated as 1 (and in adobe mode, 1 is treated as 2). I don't think these edge cases need to be documented; nowadays we'd warn/error for those cases, but that's not really worth breaking backwards compatibility.

---

📚 Documentation preview 📚: https://cpython-previews--119409.org.readthedocs.build/

[miss-islington-app]

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

[miss-islington-app]

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

[bedevere-app]

GH-119482 is a backport of this pull request to the 3.12 branch.

[bedevere-app]

GH-119483 is a backport of this pull request to the 3.13 branch.

[bedevere-bot]

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot wasm32-wasi 3.x has failed when building commit ffa24aa.

What do you need to do:

1. Don't panic.
2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
3. Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/1046/builds/5268) and take a look at the build logs.
4. Check if the failure is related to this commit (ffa24aa) or if it is a false positive.
5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/1046/builds/5268

Failed tests:

• test_math
• test_statistics

Summary of the results of the build (if available):

==

Click to see traceback logs

remote: Enumerating objects: 7, done. remote: Counting objects: 14% (1/7) remote: Counting objects: 28% (2/7) remote: Counting objects: 42% (3/7) remote: Counting objects: 57% (4/7) remote: Counting objects: 71% (5/7) remote: Counting objects: 85% (6/7) remote: Counting objects: 100% (7/7) remote: Counting objects: 100% (7/7), done. remote: Compressing objects: 14% (1/7) remote: Compressing objects: 28% (2/7) remote: Compressing objects: 42% (3/7) remote: Compressing objects: 57% (4/7) remote: Compressing objects: 71% (5/7) remote: Compressing objects: 85% (6/7) remote: Compressing objects: 100% (7/7) remote: Compressing objects: 100% (7/7), done. remote: Total 7 (delta 0), reused 3 (delta 0), pack-reused 0  From https://github.com/python/cpython * branch main -> FETCH_HEAD Note: switching to 'ffa24aab107b5bc3c6ad31a6a245c226bf24b208'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c <new-branch-name> Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at ffa24aab10 Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409) Switched to and reset branch 'main' configure: WARNING: no system libmpdecimal found; falling back to bundled libmpdecimal (deprecated and scheduled for removal in Python 3.15)configure: WARNING: using cross tools not prefixed with host tripletconfigure: WARNING: no system libmpdecimal found; falling back to bundled libmpdecimal (deprecated and scheduled for removal in Python 3.15) In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:130:11: warning: 'htole32' macro redefined [-Wmacro-redefined] 130 | # define htole32(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:43:9: note: previous definition is here 43 | #define htole32(x) (uint32_t)(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:131:11: warning: 'le32toh' macro redefined [-Wmacro-redefined] 131 | # define le32toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:44:9: note: previous definition is here 44 | #define le32toh(x) (uint32_t)(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:132:11: warning: 'htobe32' macro redefined [-Wmacro-redefined] 132 | # define htobe32(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:37:9: note: previous definition is here 37 | #define htobe32(x) __bswap32(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:138:11: warning: 'be32toh' macro redefined [-Wmacro-redefined] 138 | # define be32toh(x) (htobe32((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:38:9: note: previous definition is here 38 | #define be32toh(x) __bswap32(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:140:11: warning: 'htole64' macro redefined [-Wmacro-redefined] 140 | # define htole64(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:45:9: note: previous definition is here 45 | #define htole64(x) (uint64_t)(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:141:11: warning: 'le64toh' macro redefined [-Wmacro-redefined] 141 | # define le64toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:46:9: note: previous definition is here 46 | #define le64toh(x) (uint64_t)(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:142:11: warning: 'htobe64' macro redefined [-Wmacro-redefined] 142 | # define htobe64(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:39:9: note: previous definition is here 39 | #define htobe64(x) __bswap64(x) |^ In file included from ../../Modules/md5module.c:46: In file included from ../../Modules/_hacl/Hacl_Hash_MD5.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:149:11: warning: 'be64toh' macro redefined [-Wmacro-redefined] 149 | # define be64toh(x) (htobe64((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:40:9: note: previous definition is here 40 | #define be64toh(x) __bswap64(x) |^ 8 warnings generated. In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:130:11: warning: 'htole32' macro redefined [-Wmacro-redefined] 130 | # define htole32(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:43:9: note: previous definition is here 43 | #define htole32(x) (uint32_t)(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:131:11: warning: 'le32toh' macro redefined [-Wmacro-redefined] 131 | # define le32toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:44:9: note: previous definition is here 44 | #define le32toh(x) (uint32_t)(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:132:11: warning: 'htobe32' macro redefined [-Wmacro-redefined] 132 | # define htobe32(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:37:9: note: previous definition is here 37 | #define htobe32(x) __bswap32(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:138:11: warning: 'be32toh' macro redefined [-Wmacro-redefined] 138 | # define be32toh(x) (htobe32((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:38:9: note: previous definition is here 38 | #define be32toh(x) __bswap32(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:140:11: warning: 'htole64' macro redefined [-Wmacro-redefined] 140 | # define htole64(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:45:9: note: previous definition is here 45 | #define htole64(x) (uint64_t)(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:141:11: warning: 'le64toh' macro redefined [-Wmacro-redefined] 141 | # define le64toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:46:9: note: previous definition is here 46 | #define le64toh(x) (uint64_t)(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:142:11: warning: 'htobe64' macro redefined [-Wmacro-redefined] 142 | # define htobe64(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:39:9: note: previous definition is here 39 | #define htobe64(x) __bswap64(x) |^ In file included from ../../Modules/sha1module.c:47: In file included from ../../Modules/_hacl/Hacl_Hash_SHA1.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:149:11: warning: 'be64toh' macro redefined [-Wmacro-redefined] 149 | # define be64toh(x) (htobe64((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:40:9: note: previous definition is here 40 | #define be64toh(x) __bswap64(x) |^ 8 warnings generated. In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:130:11: warning: 'htole32' macro redefined [-Wmacro-redefined] 130 | # define htole32(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:43:9: note: previous definition is here 43 | #define htole32(x) (uint32_t)(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:131:11: warning: 'le32toh' macro redefined [-Wmacro-redefined] 131 | # define le32toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:44:9: note: previous definition is here 44 | #define le32toh(x) (uint32_t)(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:132:11: warning: 'htobe32' macro redefined [-Wmacro-redefined] 132 | # define htobe32(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:37:9: note: previous definition is here 37 | #define htobe32(x) __bswap32(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:138:11: warning: 'be32toh' macro redefined [-Wmacro-redefined] 138 | # define be32toh(x) (htobe32((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:38:9: note: previous definition is here 38 | #define be32toh(x) __bswap32(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:140:11: warning: 'htole64' macro redefined [-Wmacro-redefined] 140 | # define htole64(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:45:9: note: previous definition is here 45 | #define htole64(x) (uint64_t)(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:141:11: warning: 'le64toh' macro redefined [-Wmacro-redefined] 141 | # define le64toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:46:9: note: previous definition is here 46 | #define le64toh(x) (uint64_t)(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:142:11: warning: 'htobe64' macro redefined [-Wmacro-redefined] 142 | # define htobe64(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:39:9: note: previous definition is here 39 | #define htobe64(x) __bswap64(x) |^ In file included from ../../Modules/sha3module.c:59: In file included from ../../Modules/_hacl/Hacl_Hash_SHA3.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:149:11: warning: 'be64toh' macro redefined [-Wmacro-redefined] 149 | # define be64toh(x) (htobe64((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:40:9: note: previous definition is here 40 | #define be64toh(x) __bswap64(x) |^ 8 warnings generated. ../../Modules/expat/xmlparse.c:7839:11: warning: format specifies type 'int' but the argument has type 'ptrdiff_t' (aka 'long') [-Wformat] 7838 | " (+" EXPAT_FMT_PTRDIFF_T("6") " bytes %s|%d, xmlparse.c:%d) %*s\"", |~~~~~~~~~~~~~~~~~~~~~~~~ 7839 | bytesMore, (account == XML_ACCOUNT_DIRECT) ? "DIR" : "EXP", |^~~~~~~~~ 1 warning generated. ../../Modules/_testinternalcapi/test_critical_sections.c:142:1: warning: unused function 'thread_critical_sections' [-Wunused-function] 142 | thread_critical_sections(void *arg) |^~~~~~~~~~~~~~~~~~~~~~~~ 1 warning generated. ../../Modules/posixmodule.c:7826:1: warning: unused function 'warn_about_fork_with_threads' [-Wunused-function] 7826 | warn_about_fork_with_threads(const char* name) |^~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1 warning generated. In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:130:11: warning: 'htole32' macro redefined [-Wmacro-redefined] 130 | # define htole32(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:43:9: note: previous definition is here 43 | #define htole32(x) (uint32_t)(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:131:11: warning: 'le32toh' macro redefined [-Wmacro-redefined] 131 | # define le32toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:44:9: note: previous definition is here 44 | #define le32toh(x) (uint32_t)(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:132:11: warning: 'htobe32' macro redefined [-Wmacro-redefined] 132 | # define htobe32(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:37:9: note: previous definition is here 37 | #define htobe32(x) __bswap32(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:138:11: warning: 'be32toh' macro redefined [-Wmacro-redefined] 138 | # define be32toh(x) (htobe32((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:38:9: note: previous definition is here 38 | #define be32toh(x) __bswap32(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:140:11: warning: 'htole64' macro redefined [-Wmacro-redefined] 140 | # define htole64(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:45:9: note: previous definition is here 45 | #define htole64(x) (uint64_t)(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:141:11: warning: 'le64toh' macro redefined [-Wmacro-redefined] 141 | # define le64toh(x) (x) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:46:9: note: previous definition is here 46 | #define le64toh(x) (uint64_t)(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:142:11: warning: 'htobe64' macro redefined [-Wmacro-redefined] 142 | # define htobe64(x) \ |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:39:9: note: previous definition is here 39 | #define htobe64(x) __bswap64(x) |^ In file included from ../../Modules/sha2module.c:48: In file included from ../../Modules/_hacl/Hacl_Hash_SHA2.h:35: In file included from ../../Modules/_hacl/include/krml/types.h:12: ../../Modules/_hacl/include/krml/lowstar_endianness.h:149:11: warning: 'be64toh' macro redefined [-Wmacro-redefined] 149 | # define be64toh(x) (htobe64((x))) |^ /opt/wasi-sdk-21.0/bin/../share/wasi-sysroot/include/endian.h:40:9: note: previous definition is here 40 | #define be64toh(x) __bswap64(x) |^ 8 warnings generated. Kill <WorkerThread #2 running test=test_statistics pid=1503013 time=25 min> process group Kill <WorkerThread #1 running test=test_math pid=1504429 time=25 min> process group make: *** [Makefile:2208: buildbottest] Error 2 Cannot open file '/home/buildbot/buildarea/3.x.bcannon-wasi.wasi.debug/build/build/cross-build/wasm32-wasi/test-results.xml' for upload