Ned Batchelder
bcb435ee8f
docs: module page titles should not start with a link to themselves ( #117099 )
2024-05-08 20:34:40 +01:00
Hugo van Kemenade
3375282bb8
Docs: add link roles with Sphinx extlinks ( #117850 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
Brian Schubert
b02ab65e80
gh-115664: Fix chronological ordering of versionadded and versionchanged directives ( #115676 )
2024-02-19 17:54:54 +00:00
Masayuki Moriyama
1476ac2c58
gh-102388: Add windows_31j to aliases for cp932 codec ( #102389 )
...
The charset name "Windows-31J" is registered in the IANA Charset Registry[1]
and is implemented in Python as the cp932 codec.
[1] https://www.iana.org/assignments/charset-reg/windows-31J
Signed-off-by: Masayuki Moriyama <masayuki.moriyama@miraclelinux.com>
2024-02-19 17:01:35 +09:00
Nikita Sobolev
a89708aeea
gh-101100: Fix sphinx warnings in `library/codecs.rst` ( #110979 )
2023-10-19 17:20:52 +03:00
Jacob Coffee
e27adc68cc
gh-109634: Fix `:samp:` syntax (GH-110073)
2023-09-29 14:21:34 +03:00
Serhiy Storchaka
92af0cc580
gh-109634: Use :samp: role (GH-109635)
2023-09-23 09:31:20 +03:00
Stanley
d9407b174c
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode ( #94370 )
2022-10-21 16:01:05 -07:00
Christian Heimes
f81a6c5fc7
gh-95415: Make availability directive consistent (GH-95416)
2022-07-29 16:42:09 +02:00
Ma Lin
5bc2390229
bpo-38056: overhaul Error Handlers section in codecs documentation ( #15732 )
...
* Some handlers were wrongly described as text-encoding only, but actually they can also be used in text-decoding.
* Add more description to each handler.
* Add two REPL examples.
* Add indexes for Error Handler's name.
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-08 19:58:55 -07:00
slateny
6a7a8a740e
Doc: Fix link formatting typo (GH-91659)
2022-04-19 18:15:46 +09:00
180909
ea56845744
codecs docs: fix grammar mistake (GH-29462)
2022-04-02 14:12:32 -07:00
slateny
a8c87a239e
bpo-21910: Clarify docs for codecs writelines method (GH-31245)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-03-02 17:21:41 -08:00
Terry Jan Reedy
4c0fc65cd8
bpo-45277: Fix typo in codecs doc (GH-28555)
...
encoding => encode
2021-09-24 21:56:09 -04:00
Victor Stinner
19ba2122ac
bpo-37330: open() no longer accept 'U' in file mode (GH-28118)
...
open(), io.open(), codecs.open() and fileinput.FileInput no longer
accept "U" ("universal newline") in the file mode. This flag was
deprecated since Python 3.3.
2021-09-02 12:58:00 +02:00
Inada Naoki
5c84bb506a
bpo-37751: Update `codecs.register()` doc. (GH-25643)
2021-04-28 09:37:02 +09:00
Gregory P. Smith
1d023e374c
bpo-17305: Link to the third-party idna package. (GH-25208)
...
So long as we don't have idna2008 in the standard library, we should at least point people to the third-party solution.
2021-04-06 00:55:45 -07:00
Berker Peksag
1a9f51ed12
bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)
2021-01-06 04:14:42 +02:00
Hai Shi
d332e7b816
bpo-41842: Add codecs.unregister() function (GH-22360)
...
Add codecs.unregister() and PyCodec_Unregister() functions
to unregister a codec search function.
2020-09-28 23:41:11 +02:00
Victor Stinner
942f7a2dea
bpo-39674: Revert "bpo-37330: open() no longer accept 'U' in file mode (GH-16959)" (GH-18767)
...
This reverts commit e471e72977
.
The mode will be removed from Python 3.10.
2020-03-04 18:50:22 +01:00
Victor Stinner
e471e72977
bpo-37330: open() no longer accept 'U' in file mode (GH-16959)
...
open(), io.open(), codecs.open() and fileinput.FileInput no longer
accept "U" ("universal newline") in the file mode. This flag was
deprecated since Python 3.3.
2019-10-28 15:40:08 +01:00
Géry Ogam
891e9e3b44
Correct typos in the codecs module documentation ( #15135 )
2019-09-12 08:41:32 +01:00
Ashwin Ramaswami
c4c15ed7a2
bpo-35551: encodings update (GH-11446)
2019-06-05 18:18:06 -04:00
Victor Stinner
3aef48e315
bpo-36778: Update cp65001 codec documentation (GH-13240)
...
Remove cp65001 from the codecs table, list it as an alias of utf_8
and add a versionchanged markup.
2019-05-13 10:42:31 +02:00
Victor Stinner
d267ac20c3
bpo-36778: cp65001 encoding becomes an alias to utf_8 (GH-13230)
2019-05-10 03:19:54 +02:00
Christopher Thorne
b5e2959b27
Doc: fix typo in IncrementalDecoder.setstate (GH-12724)
2019-04-11 15:09:29 +09:00
Inada Naoki
6a16b18224
bpo-36297: remove "unicode_internal" codec (GH-12342)
2019-03-18 15:44:11 +09:00
Serhiy Storchaka
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)
2018-10-31 02:26:06 +02:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02:00
Alexey Izbyshev
a2670565d8
bpo-32236: open() emits RuntimeWarning if buffering=1 for binary mode (GH-4842)
...
If buffering=1 is specified for open() in binary mode, it is silently
treated as buffering=-1 (i.e., the default buffer size).
Coupled with the fact that line buffering is always supported in Python 2,
such behavior caused several issues (e.g., bpo-10344, bpo-21332).
Warn that line buffering is not supported if open() is called with
binary mode and buffering=1.
2018-10-20 02:22:31 +02:00
Cheryl Sabella
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
Serhiy Storchaka
0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
...
85% of them are already links.
2018-05-31 07:39:00 +03:00
Ville Skyttä
297fd876aa
bpo-28393: Update encoding lookup docs wrt bpo-27938 ( #4871 )
2017-12-15 11:19:23 +01:00
Pablo Galindo
e184cfd7bf
bpo-31824: Document default value of 'errors' parameters (GH-4328)
2017-11-11 02:05:12 +03:00
Zhiming Wang
30644dee0c
Improve IncrementalEncoder documentation (GH-2746)
...
getstate and setstate are instance methods, same as encode and reset.
2017-09-09 23:09:55 -07:00
Serhiy Storchaka
0264e46caa
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:49:59 +02:00
Serhiy Storchaka
c7b1a0bbe2
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:43:28 +02:00
Martin Panter
36700e4578
Issue #23231 : Merge codecs doc from 3.5 into 3.6
2016-10-15 01:04:08 +00:00
Martin Panter
c73e9d844f
Issue #23231 : Document codecs.iterencode(), iterdecode() shortcomings
2016-10-15 00:56:47 +00:00
Steve Dower
5a71327f35
Issue #27959 : Documents new encoding and alias.
2016-09-06 19:46:42 -07:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Berker Peksag
732ba821ca
Issue #27075 : Link to StreamReader and StreamWriter docs
...
Patch by Ville Skyttä.
2016-05-21 14:56:35 +03:00
Martin Panter
4c35964b76
Corrections for a/an in code comments and documentation
2016-05-08 13:53:41 +00:00
Serhiy Storchaka
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
Victor Stinner
0ec69a6a41
Merge 3.4 (codecs, issue #24894 )
2015-09-24 09:04:26 +02:00
Victor Stinner
bfd9767e0f
Issue #24894 : Document the codec iso8859_11
...
Patch written by Prashant Tyagi.
2015-09-24 09:04:05 +02:00
Martin Panter
9ab96946ee
Issue #16473 : Merge codecs doc and test from 3.4 into 3.5
2015-09-12 01:22:17 +00:00
Martin Panter
06171bd52a
Issue #16473 : Fix byte transform codec documentation; test quotetabs=True
...
This changes the equivalent functions listed for the Base-64, hex and Quoted-
Printable codecs to reflect the functions actually used. Also mention and
test the "quotetabs" setting for Quoted-Printable encoding.
2015-09-12 00:34:28 +00:00
Berker Peksag
41ca828580
Issue #12160 : Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
...
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().
Patch by Nick Weinhold.
2015-07-30 18:26:10 +03:00
Berker Peksag
7e94e8ea4b
Issue #12160 : Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
...
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().
Patch by Nick Weinhold.
2015-07-30 18:26:35 +03:00