Commit graph

117 commits

Author SHA1 Message Date
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
Serhiy Storchaka
f0eeedf0d8 Issue #22681: Added support for the koi8_t encoding. 2015-05-12 23:24:19 +03:00
Serhiy Storchaka
ad8a1c3fb2 Issue #22682: Added support for the kz1048 encoding. 2015-05-12 23:16:55 +03:00
Georg Brandl
961dfa10a6 Merge with 3.4 2015-02-25 13:07:03 +01:00
Georg Brandl
7e91af3a91 Remove unsupported (in latex) character from the source. 2015-02-25 13:05:53 +01:00
Serhiy Storchaka
07985ef387 Issue #22286: The "backslashreplace" error handlers now works with
decoding and translating.
2015-01-25 22:56:57 +02:00
Serhiy Storchaka
d3faf43f9b Issue #23181: More "codepoint" -> "code point". 2015-01-18 11:28:37 +02:00
Georg Brandl
3be472b5f7 Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Nick Coghlan
f212636fe3 Issue #19548: clean up merge issues in codecs docs
Patch by Martin Panter to clean up some problems with the merge
of the codecs docs changes from Python 3.4.
2015-01-07 13:14:47 +10:00
Nick Coghlan
582acb75e9 Merge issue 19548 changes from 3.4 2015-01-07 00:37:01 +10:00
Nick Coghlan
b9fdb7a452 Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Berker Peksag
87f6c2212e Issue #19676: Tweak documentation a bit.
* Updated version info to 3.5
* Fixed a markup error
* Added a versionadded directive to namereplace_errors documentation
2014-11-25 18:59:20 +02:00
Serhiy Storchaka
166ebc4e5d Issue #19676: Added the "namereplace" error handler. 2014-11-25 13:57:17 +02:00
Victor Stinner
f6a271ae98 Issue #18395: Rename `_Py_char2wchar() to :c:func:Py_DecodeLocale`, rename
``_Py_wchar2char()`` to :c:func:`Py_EncodeLocale`, and document these
functions.
2014-08-01 12:28:48 +02:00
Larry Hastings
f5caf2b30b Checking in this change LOCAL ONLY NO UPLOAD ANYWHERE 2015-02-25 04:15:33 -08:00
Victor Stinner
ef5b4e3dc3 Issue #21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
Patch written by Brad Aylsworth.
2014-05-14 17:08:45 +02:00
Andrew Kuchling
2e3743cd30 #13437: link to the source code for a few more modules 2014-03-19 16:23:01 -04:00
R David Murray
c4c7b1ccb6 whatsnew: cp273 codec (#10907797)
Also updated the docs and added the aliases mentioned by the
references.
2014-03-07 21:00:34 -05:00
R David Murray
47d083cf1a whatsnew: cp273 codec (#10907797)
Also updated the docs and added the aliases mentioned by the
references.
2014-03-07 21:00:34 -05:00
Serhiy Storchaka
be0c3250b1 Issue #19668: Added support for the cp1125 encoding. 2013-11-23 18:52:23 +02:00
Nick Coghlan
9c1aed8f94 Close #7475: Restore binary & text transform codecs
The codecs themselves were restored in Python 3.2, this
completes the restoration by adding back the convenience
aliases.

These aliases were originally left out due to confusing
errors when attempting to use them with the text encoding
specific convenience methods. Python 3.4 includes several
improvements to those errors, thus permitting the aliases
to be restored as well.
2013-11-23 11:13:36 +10:00
Serhiy Storchaka
58cf607d13 Issue #12892: The utf-16* and utf-32* codecs now reject (lone) surrogates.
The utf-16* and utf-32* encoders no longer allow surrogate code points
(U+D800-U+DFFF) to be encoded.
The utf-32* decoders no longer decode byte sequences that correspond to
surrogate code points.
The surrogatepass error handler now works with the utf-16* and utf-32* codecs.

Based on patches by Victor Stinner and Kang-Hao (Kenny) Lu.
2013-11-19 11:32:41 +02:00
Serhiy Storchaka
98b28fddd8 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:12:09 +03:00
Serhiy Storchaka
bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Nick Coghlan
e206b6e10e Issue #17827: document codecs.encode and codecs.decode
- Merge from 3.3
- Added to What's New since these are more important in 3.x,
  as the bytes<->bytes and str<->str codecs don't fit the
  text model convenience methods in 3.x the way they did the
  basestring<->basestring methods in the 2.x text model
- Included under Library in Misc/NEWS for the same reason
2013-10-14 00:55:46 +10:00
Nick Coghlan
6cb2b5b1e1 Issue #17827: Document codecs.encode and codecs.decode 2013-10-14 00:22:13 +10:00
Georg Brandl
cfcd686acf merge with 3.3 2013-10-06 13:17:14 +02:00
Georg Brandl
9c2505b8fc Fix order of required StreamReader/StreamWriter base classes. Spotted by Edward Welbourne on docs@. 2013-10-06 13:17:04 +02:00
Nick Coghlan
fdf239a855 Close #17839: support bytes-like objects in base64 module
This mostly affected the encodebytes and decodebytes function
(which are used by base64_codec)

Also added a test to ensure all bytes-bytes codecs can handle
memoryview input and tests for handling of multidimensional
and non-bytes format input in the modern base64 API.
2013-10-03 00:43:22 +10:00
Serhiy Storchaka
cca40ffa97 Issue #18336. Fix a link to StreamReader's read() method. 2013-07-11 18:26:13 +03:00
Andrew Kuchling
c7b6c50f29 Describe 'surrogateescape' in the documentation.
Also, improve some docstring descriptions of the 'errors' parameter.

Closes #14015.
2013-06-16 12:58:48 -04:00
Nick Coghlan
650e322fc6 Issue 17844: Clarify meaning of different codec tables 2013-05-23 20:24:02 +10:00
Serhiy Storchaka
9e62d35e65 Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs. 2013-05-22 15:33:09 +03:00