Commit Graph

103 Commits

Author SHA1 Message Date
Martin Panter 4f23cabc16 Corrections for a/an in code comments and documentation 2016-05-08 13:45:55 +00:00
Serhiy Storchaka b4905efe23 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:50:12 +03:00
Victor Stinner 68dafe5f14 Issue #24894: Document the codec iso8859_11
Patch written by Prashant Tyagi.
2015-09-24 09:05:19 +02:00
Martin Panter b2528c92f1 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 ffc7e8eebe 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 23:27:13 +03:00
Georg Brandl a44ec3ff4c Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Victor Stinner 07b16159b8 Issue #21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
Patch written by Brad Aylsworth.
2014-05-14 17:07:08 +02:00
Nick Coghlan 6a98749e9c Close #17827: Document codecs.encode & codecs.decode 2013-11-04 20:05:16 +10:00
Serhiy Storchaka b33336f650 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:00 +03:00
Georg Brandl 42dac47c96 Fix order of required StreamReader/StreamWriter base classes. Spotted by Edward Welbourne on docs@. 2013-10-06 13:17:04 +02:00
Serhiy Storchaka 6cda0adf3a Issue #18336. Fix a link to StreamReader's read() method. 2013-07-11 18:25:19 +03:00
Serhiy Storchaka 54f70923a3 Issue #17844: Refactor a documentation of Python specific encodings.
Add links to encoders and decoders for binary-to-binary codecs.
2013-05-22 15:28:30 +03:00
Ezio Melotti 59391207c6 #17714: document that the base64 codec adds a trailing newline. 2013-05-07 11:14:27 +03:00
Georg Brandl 75da35747e Backport rev. 3ae74b361f53 to 2.7 branch. 2013-03-28 13:35:18 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Benjamin Peterson 196035595f document that encoding error handlers may return bytes (#16585) 2012-12-02 11:26:10 -05:00
Antoine Pitrou b79be95dac Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:54:27 +02:00
Antoine Pitrou fbd4f80979 Issue #15444: Use proper spelling for non-ASCII contributor names.
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
Sandro Tosi 98ed08f24e update to new C roles and directives 2012-01-14 16:42:02 +01:00
Victor Stinner 9f4b1e9c50 Fix and deprecated the unicode_internal codec
unicode_internal codec uses Py_UNICODE instead of the real internal
representation (PEP 393: Py_UCS1, Py_UCS2 or Py_UCS4) for backward
compatibility.
2011-11-10 20:56:30 +01:00
Ezio Melotti 59b13f4de9 Refactor a bit the codecs doc. 2011-10-25 10:46:22 +03:00
Victor Stinner 2f3ca9f20e Close #13247: Add cp65001 codec, the Windows UTF-8 (CP_UTF8) 2011-10-27 01:38:56 +02:00
Ezio Melotti 92b958420e Merge the codecs doc refactoring with 3.2. 2011-10-25 10:41:37 +03:00
Ezio Melotti fbb39815d4 Refactor a bit the codecs doc. 2011-10-25 10:40:38 +03:00
Ezio Melotti 7a03f64c2e Remove mention of narrow/wide builds in the codecs doc. 2011-10-25 10:30:19 +03:00
Victor Stinner 3a50e7056e Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
error handlers on all Windows versions. The MBCS codec is now supporting all
error handlers, instead of only replace to encode and ignore to decode.
2011-10-18 21:21:00 +02:00
Ezio Melotti 4f14a1ff52 From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc. 2011-09-01 08:19:01 +03:00
Ezio Melotti c2d9a0226e Merge doc fix with 3.2. 2011-09-01 08:13:46 +03:00
Ezio Melotti 222b20844f From RFC 3629 5- and 6-bytes UTF-8 sequences are invalid, so remove them from the doc. 2011-09-01 08:11:28 +03:00
Victor Stinner e15dce3d18 Close #12171: IncrementalEncoder.reset() of CJK codecs (multibytecodec) calls
encreset() instead of decreset().
2011-05-30 22:56:00 +02:00
Victor Stinner 0501070669 Revert my commit 3555cf6f9c98: "Issue #8796: codecs.open() calls the builtin
open() function instead of using StreamReaderWriter. Deprecate StreamReader,
StreamWriter, StreamReaderWriter, StreamRecoder and EncodedFile() of the codec
module. Use the builtin open() function or io.TextIOWrapper instead."

"It has not been approved !" wrote Marc-Andre Lemburg.
2011-05-27 16:50:40 +02:00
Victor Stinner 98fe1a0c3b Issue #8796: codecs.open() calls the builtin open() function instead of using
StreamReaderWriter. Deprecate StreamReader, StreamWriter, StreamReaderWriter,
StreamRecoder and EncodedFile() of the codec module. Use the builtin open()
function or io.TextIOWrapper instead.
2011-05-27 01:51:18 +02:00
R David Murray a2472d28fd Transplant: Fix wording and clarify that the IDNA codec operates on full domain names.
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:20:30 -04:00
R David Murray c6652ca468 Merge: Fix wording and clarify that the IDNA codec operates on full domain names.
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:13:52 -04:00
R David Murray 5864c9f26c Merge: Fix wording and clarify that the IDNA codec operates on full domain names.
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:12:59 -04:00
R David Murray e0fd2f880e Fix wording and clarify that the IDNA codec operates on full domain names.
Before reading the code to check, I wasn't sure if it operated on
full domain names or just individual labels.
2011-04-13 14:12:18 -04:00
Alexander Belopolsky 1d52146a25 Issue #11303: Added shortcuts for utf8 and latin1 encodings.
Documented the list of optimized encodings as CPython implementation
detail.
2011-02-25 19:19:57 +00:00
Éric Araujo a8132ec27e Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines

  Fix usage of :option: in the docs (#9312).

  :option: is used to create a link to an option of python, not to mark
  up any instance of any arbitrary command-line option.  These were
  changed to ````.

  For modules which do have a command-line interface, lists of options
  have been properly marked up with the program/cmdoption directives
  combo.  Options defined in such blocks can be linked to with :option:
  later in the same file, they won’t link to an option of python.

  Finally, the markup of command-line fragments in optparse.rst has
  been cleaned to use ``x`` instead of ``"x"``, keeping that latter
  form for actual Python strings.

  Patch by Eli Bendersky and Éric Araujo.
........
  r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines

  Style edits in followup to r86521 (#9312)
........
  r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines

  Use link-generating markup (see #9312)
........
  r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines

  Rewrap long lines + minor edits
........
  r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines

  No need to generate a link for something that’s just above.
........
  r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m” instead of direct filename.
........
  r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m test” over test.regrtest (r87296 followup)
........
  r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines

  Add versionadded directive missing from r78983.
........
2010-12-16 03:53:53 +00:00
Éric Araujo 3efdf0630b Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines

  Fix usage of :option: in the docs (#9312).

  :option: is used to create a link to an option of python, not to mark
  up any instance of any arbitrary command-line option.  These were
  changed to ````.

  For modules which do have a command-line interface, lists of options
  have been properly marked up with the program/cmdoption directives
  combo.  Options defined in such blocks can be linked to with :option:
  later in the same file, they won’t link to an option of python.

  Finally, the markup of command-line fragments in optparse.rst has
  been cleaned to use ``x`` instead of ``"x"``, keeping that latter
  form for actual Python strings.

  Patch by Eli Bendersky and Éric Araujo.
........
  r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines

  Style edits in followup to r86521 (#9312)
........
  r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines

  Use link-generating markup (see #9312)
........
  r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines

  Rewrap long lines + minor edits
........
  r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines

  No need to generate a link for something that’s just above.
........
  r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m” instead of direct filename.
........
  r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines

  Advertise “python -m test” over test.regrtest (r87296 followup)
........
  r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines

  Add versionadded directive missing from r78983.
........
2010-12-16 03:16:29 +00:00
Benjamin Peterson 28a4dce6a8 remove (un)transform methods 2010-12-12 01:33:04 +00:00
Victor Stinner 53a9dd776e Issue #10546: UTF-16-LE and UTF-16-BE *do* support non-BMP characters
Fix the doc and add tests.
2010-12-08 22:25:45 +00:00
Georg Brandl 02524629f3 #7475: add (un)transform method to bytes/bytearray and str, add back codecs that can be used with them from Python 2. 2010-12-02 18:06:51 +00:00
Éric Araujo 713d3039dc Fix usage of :option: in the docs (#9312).
:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option.  These were
changed to ````.

For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo.  Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.

Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.

Patch by Eli Bendersky and Éric Araujo.
2010-11-18 16:38:46 +00:00
Georg Brandl 60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00
Georg Brandl 16215c732c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

................
  r78959 | georg.brandl | 2010-03-14 11:56:14 +0100 (So, 14 Mär 2010) | 33 lines

  Merged revisions 78760,78771-78773,78802,78922,78952 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r78760 | georg.brandl | 2010-03-07 16:23:59 +0100 (So, 07 Mär 2010) | 1 line

    #5341: more built-in vs builtin fixes.
  ........
    r78771 | georg.brandl | 2010-03-07 21:58:31 +0100 (So, 07 Mär 2010) | 1 line

    #8085: The function is called PyObject_NewVar, not PyObject_VarNew.
  ........
    r78772 | georg.brandl | 2010-03-07 22:12:28 +0100 (So, 07 Mär 2010) | 1 line

    #8039: document conditional expressions better, giving them their own section.
  ........
    r78773 | georg.brandl | 2010-03-07 22:32:06 +0100 (So, 07 Mär 2010) | 1 line

    #8044: document Py_{Enter,Leave}RecursiveCall functions.
  ........
    r78802 | georg.brandl | 2010-03-08 17:28:40 +0100 (Mo, 08 Mär 2010) | 1 line

    Fix typo.
  ........
    r78922 | georg.brandl | 2010-03-13 14:41:58 +0100 (Sa, 13 Mär 2010) | 1 line

    Update for new download location.
  ........
    r78952 | georg.brandl | 2010-03-14 10:55:08 +0100 (So, 14 Mär 2010) | 1 line

    #8137: add iso-8859-16 to the standard encodings table.
  ........
................
  r79170 | georg.brandl | 2010-03-21 10:02:59 +0100 (So, 21 Mär 2010) | 1 line

  Fix some issues found by Jacques Ducasse on the docs list.
................
  r79175 | georg.brandl | 2010-03-21 10:10:32 +0100 (So, 21 Mär 2010) | 9 lines

  Merged revisions 79172 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79172 | georg.brandl | 2010-03-21 10:08:00 +0100 (So, 21 Mär 2010) | 1 line

    Add a paragraph about set displays.
  ........
................
  r79177 | georg.brandl | 2010-03-21 10:25:54 +0100 (So, 21 Mär 2010) | 1 line

  Need to use list(range()) to get a list.
................
  r79180 | georg.brandl | 2010-03-21 10:50:49 +0100 (So, 21 Mär 2010) | 9 lines

  Merged revisions 79178 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79178 | georg.brandl | 2010-03-21 10:28:16 +0100 (So, 21 Mär 2010) | 1 line

    Clarify that for shell=True, the shell PID will be the child PID.
  ........
................
  r79183 | georg.brandl | 2010-03-21 10:52:24 +0100 (So, 21 Mär 2010) | 9 lines

  Merged revisions 79181 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79181 | georg.brandl | 2010-03-21 10:51:16 +0100 (So, 21 Mär 2010) | 1 line

    Update os.kill() emulation example for Windows to use ctypes.
  ........
................
  r79186 | georg.brandl | 2010-03-21 11:03:36 +0100 (So, 21 Mär 2010) | 13 lines

  Merged revisions 79184-79185 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79184 | georg.brandl | 2010-03-21 10:58:36 +0100 (So, 21 Mär 2010) | 1 line

    Update text for newest US DST regulation.  The sample file already has the calculation right.
  ........
    r79185 | georg.brandl | 2010-03-21 11:02:47 +0100 (So, 21 Mär 2010) | 1 line

    Include structmember.h correctly.
  ........
................
  r79193 | georg.brandl | 2010-03-21 12:53:50 +0100 (So, 21 Mär 2010) | 9 lines

  Merged revisions 79192 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r79192 | georg.brandl | 2010-03-21 12:50:58 +0100 (So, 21 Mär 2010) | 1 line

    Remove leftover word.
  ........
................
  r79581 | georg.brandl | 2010-04-02 10:47:07 +0200 (Fr, 02 Apr 2010) | 1 line

  #8213: document behavior of -u on py3k better.
................
2010-10-06 07:59:52 +00:00
Benjamin Peterson 23110e7361 alias macintosh to mac_roman #843590 2010-08-21 02:54:44 +00:00
Benjamin Peterson 5a6214afe2 Merged revisions 81499,81506 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81499 | georg.brandl | 2010-05-24 16:29:07 -0500 (Mon, 24 May 2010) | 1 line

  #8016: add the CP858 codec (approved by Benjamin).  (Also add CP720 to the tests, it was missing there.)
........
  r81506 | benjamin.peterson | 2010-05-24 17:04:53 -0500 (Mon, 24 May 2010) | 1 line

  set svn:eol-style
........
2010-06-27 22:41:29 +00:00
Victor Stinner 554f3f0081 Issue #850997: mbcs encoding (Windows only) handles errors argument: strict
mode raises unicode errors. The encoder only supports "strict" and "replace"
error handlers, the decoder only supports "strict" and "ignore" error handlers.
2010-06-16 23:33:54 +00:00
Georg Brandl f0757a2937 #8016: add the CP858 codec (approved by Benjamin). (Also add CP720 to the tests, it was missing there.) 2010-05-24 21:29:07 +00:00
Georg Brandl 93dc9eb2a3 Merged revisions 78760,78771-78773,78802,78922,78952 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78760 | georg.brandl | 2010-03-07 16:23:59 +0100 (So, 07 Mär 2010) | 1 line

  #5341: more built-in vs builtin fixes.
........
  r78771 | georg.brandl | 2010-03-07 21:58:31 +0100 (So, 07 Mär 2010) | 1 line

  #8085: The function is called PyObject_NewVar, not PyObject_VarNew.
........
  r78772 | georg.brandl | 2010-03-07 22:12:28 +0100 (So, 07 Mär 2010) | 1 line

  #8039: document conditional expressions better, giving them their own section.
........
  r78773 | georg.brandl | 2010-03-07 22:32:06 +0100 (So, 07 Mär 2010) | 1 line

  #8044: document Py_{Enter,Leave}RecursiveCall functions.
........
  r78802 | georg.brandl | 2010-03-08 17:28:40 +0100 (Mo, 08 Mär 2010) | 1 line

  Fix typo.
........
  r78922 | georg.brandl | 2010-03-13 14:41:58 +0100 (Sa, 13 Mär 2010) | 1 line

  Update for new download location.
........
  r78952 | georg.brandl | 2010-03-14 10:55:08 +0100 (So, 14 Mär 2010) | 1 line

  #8137: add iso-8859-16 to the standard encodings table.
........
2010-03-14 10:56:14 +00:00