Commit Graph

671 Commits

Author SHA1 Message Date
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Martin Panter 1ce738e08f Merge typo fixes from 3.5 2016-05-08 14:02:35 +00:00
Martin Panter f0564164ba Fix typos in comments, documentation and test method names 2016-05-08 13:48:10 +00:00
Serhiy Storchaka 1acbf853c8 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:58 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Raymond Hettinger c5c43b8374 merge 2016-04-26 01:11:28 -07:00
Raymond Hettinger b9531bcdcc Issue #24715: Improve sort stability example 2016-04-26 01:11:10 -07:00
Benjamin Peterson 9046df0659 merge 3.5 (#26827) 2016-04-22 23:43:24 -07:00
Benjamin Peterson 95b5f0ad7e fix python 3 mod init function declaration (closes #26827) 2016-04-22 23:43:10 -07:00
Martin Panter cda80940ed Issue #15984: Merge PyUnicode doc from 3.5 2016-04-15 02:27:11 +00:00
Martin Panter 6245cb3c01 Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
This affects documentation, code comments, and a debugging messages.
2016-04-15 02:14:19 +00:00
Serhiy Storchaka 336fc5bbb0 Issue #25910: Fixed dead links in the docs. 2016-04-11 12:34:07 +03:00
Serhiy Storchaka 90be7333ea Issue #25910: Fixed dead links in the docs. 2016-04-11 12:18:56 +03:00
Vinay Sajip c334202f41 Merged documentation update from 3.5. 2016-04-01 23:13:48 +01:00
Vinay Sajip d93a60149c Added a cookbook recipe for a logging context manager. 2016-04-01 23:13:01 +01:00
Berker Peksag 5d7286c05d Issue #26593: Fix typo in logging HOWTO
Patch by Andrew Szeto.
2016-03-20 12:51:16 +02:00
Berker Peksag 563c949b11 Issue #26593: Fix typo in logging HOWTO
Patch by Andrew Szeto.
2016-03-20 12:50:56 +02:00
Brett Cannon 81ae89b611 Merge for issue #26095 2016-03-18 13:24:15 -07:00
Brett Cannon adcb654519 Suggest people use feature detection in porting guide 2016-03-18 13:23:58 -07:00
Berker Peksag f1fc8f953e Issue #24852: Remove outdated "HOWTO Use Python in the web" document 2016-03-07 19:01:05 +02:00
Berker Peksag b4f2f453e7 Issue #24852: Remove outdated "HOWTO Use Python in the web" document 2016-03-07 19:00:47 +02:00
Georg Brandl a7f7232838 merge with 3.5 2016-02-28 21:09:45 +01:00
Georg Brandl 76b2ee03c3 Fix typo. 2016-02-28 21:09:36 +01:00
Georg Brandl 3902d62c4e merge with 3.5 2016-02-26 19:37:52 +01:00
Georg Brandl 5d94134040 Closes #25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch. 2016-02-26 19:37:12 +01:00
Vinay Sajip d9dc53021e Merged cookbook update from 3.5. 2016-02-20 19:03:29 +00:00
Vinay Sajip e10d370a92 Added simple threading example to logging cookbook. 2016-02-20 19:02:46 +00:00
Benjamin Peterson bd8112901a merge 3.5 (#26378) 2016-02-17 23:43:08 -08:00
Benjamin Peterson 8f0432ffbb fix typo (closes #26378) 2016-02-17 23:42:46 -08:00
Martin Panter 3008b1c4bb Issue #26304: Merge doc wording from 3.5 2016-02-10 05:44:56 +00:00
Martin Panter c04fb56e36 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Senthil Kumaran 029f7f7af2 merge from 3.5 2016-02-05 19:37:47 -08:00
Senthil Kumaran b6213c5664 Fix userinfo example presented in urllib2 howto. 2016-02-05 19:37:23 -08:00
Martin Panter 5da4e86bc0 Issue #26220: Merge Unicode how-to from 3.5 2016-01-29 04:06:49 +00:00
Martin Panter 4942870471 Issue #26220: Remove outdated comment about a question mark 2016-01-29 04:01:16 +00:00
Ezio Melotti 1d37771292 #25517: merge with 3.5. 2016-01-12 00:09:43 +02:00
Ezio Melotti 84c63e8df4 #25517: fix regex in the regex howto. Patch by Elena Oat. 2016-01-12 00:09:13 +02:00
Martin Panter a561c038ab Issue #25576: Merge www-form-urlencoded doc from 3.5 2015-11-24 22:59:28 +00:00
Martin Panter f7e8d07538 Issue #25576: Merge www-form-urlencoded doc from 3.4 into 3.5 2015-11-24 22:57:46 +00:00
Martin Panter cda85a0d1c Issue #25576: Remove application/x-www-form-urlencoded charset advice
No charset parameter is standardized for this Content-Type value. Also
clarify that urlencode() outputs ASCII.
2015-11-24 22:33:18 +00:00
Martin Panter 36befa5b4c Issue #25626: Merge zlib fix from 3.5 2015-11-21 10:57:15 +00:00
Martin Panter e99e97762c Issue #25626: Change zlib to accept Py_ssize_t and cap to UINT_MAX
The underlying zlib library stores sizes in “unsigned int”. The corresponding
Python parameters are all sizes of buffers filled in by zlib, so it is okay
to reduce higher values to the UINT_MAX internal cap. OverflowError is still
raised for sizes that do not fit in Py_ssize_t.

Sizes are now limited to Py_ssize_t rather than unsigned long, because Python
byte strings cannot be larger than Py_ssize_t. Previously this could result
in a SystemError on 32-bit platforms.

This resolves a regression in the gzip module when reading more than UINT_MAX
or LONG_MAX bytes in one call, introduced by revision 62723172412c.
2015-11-20 08:13:35 +00:00
Serhiy Storchaka 4a7c03aab4 Issue #25523: Merge a-to-an corrections from 3.5. 2015-11-02 14:44:29 +02:00
Serhiy Storchaka a84f6c3dd3 Issue #25523: Merge a-to-an corrections from 3.4. 2015-11-02 14:39:05 +02:00
Serhiy Storchaka d65c9496da Issue #25523: Further a-to-an corrections. 2015-11-02 14:10:23 +02:00
Berker Peksag 3b1cb71084 rstlint: Fix "default role used" warning
This should make buildbots green.
2015-10-20 03:42:17 +03:00
Berker Peksag db6cdf8425 rstlint: Fix "default role used" warning
This should make buildbots green.
2015-10-20 03:41:59 +03:00
Berker Peksag f84499a4e3 rstlint: Fix "default role used" warning
This should make buildbots green.
2015-10-20 03:41:38 +03:00
Vinay Sajip d469cff021 Merged cookbook update from 3.5. 2015-10-17 13:59:41 +01:00
Vinay Sajip a83a0e2316 Merged cookbook update from 3.4. 2015-10-17 13:59:12 +01:00
Vinay Sajip 4de9dae57d Added entry to logging cookbook. 2015-10-17 13:58:19 +01:00
Victor Stinner 91108f049f Issue #25210: Change error message of do_richcompare()
Don't add parenthesis to type names. Add also quotes around the type names.

Before:

  TypeError: unorderable types: int() < NoneType()

After:

  TypeError: '<' not supported between instances of 'int' and 'NoneType'
2015-10-14 18:25:31 +02:00
Vinay Sajip 09a00eb076 Closes #25344: Merged fix from 3.4. 2015-10-10 00:53:37 +01:00
Vinay Sajip ff1f3d9ff1 Closes #25344: Added cookbook recipe to show buffering of logging events. 2015-10-10 00:52:35 +01:00
Benjamin Peterson fc2fb0f621 merge 3.4 (#25145) 2015-09-20 23:18:51 +05:00
Benjamin Peterson 16ad5cfad3 remove reference to PyGoogle (#25145)
Patch by Bar Harel.
2015-09-20 23:17:41 +05:00
Benjamin Peterson 95acbcedc4 use a more modern UA (#25145) 2015-09-20 23:16:45 +05:00
Senthil Kumaran b4760efbad Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
Related Issues:

#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
Berker Peksag fee05daef8 Issue #24232: Fix typos. Patch by Ville Skyttä. 2015-05-19 01:38:05 +03:00
Berker Peksag 315e104d11 Issue #24232: Fix typos. Patch by Ville Skyttä. 2015-05-19 01:36:55 +03:00
Tal Einat 97fceee3b9 Argument Clinic: added missing bit of info in howto 2015-05-16 14:12:15 +03:00
Yury Selivanov 8170e8c0d1 PEP 479: Change StopIteration handling inside generators.
Closes issue #22906.
2015-05-09 11:44:30 -04:00
Larry Hastings 38337d1e15 Issue #24000: Improved Argument Clinic's mapping of converters to legacy
"format units".  Updated the documentation to match.
2015-05-07 23:30:09 -07:00
Brett Cannon 8396b8ef08 Fix a grammar error in the porting HOWTO as found by Eric Smith. 2015-04-13 16:32:16 -04:00
Brett Cannon fd53f98459 Issue #23733: Mention bytes.__mod__ in the porting HOWTO. 2015-04-13 16:21:07 -04:00
Antoine Pitrou 3764fc2951 Fix doc build error 2015-04-13 21:07:57 +02:00
Brett Cannon 4269d6db93 Issue #23732: Mention the new -b semantics in the porting HOWTO. 2015-04-13 14:37:50 -04:00
Berker Peksag 556e08e9b2 Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:53:33 +03:00
Berker Peksag 9575e1891f Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Serhiy Storchaka a54aae0683 Issue #23622: Unknown escapes in regular expressions that consist of ``'\'``
and ASCII letter now raise a deprecation warning and will be forbidden in
Python 3.6.
2015-03-24 22:58:14 +02:00
Brett Cannon cb1dde5df5 Merge 3.4 2015-03-13 12:50:16 -04:00
Brett Cannon 2645bad04f Make the case to only support Python 2.7 when supporting 2/3 simultaneously 2015-03-13 12:49:44 -04:00
Brett Cannon b44ed82b81 Merge with 3.4 for porting HOWTO tweaks 2015-02-27 15:10:38 -05:00
Brett Cannon fdde79dbf6 Fix the clarification as to why division cannot be ported automatically 2015-02-27 15:10:03 -05:00
Vinay Sajip 365701add9 Added respect_handler_level to QueueListener. 2015-02-09 19:49:00 +00:00
Vinay Sajip 7929be6aeb Merged documentation update from 3.4. 2015-02-01 15:18:14 +00:00
Vinay Sajip f046dfe60e Added a cookbook entry on logging audible messages. 2015-02-01 15:17:34 +00:00
Vinay Sajip 85ad88dbc6 Merged documentation update from 3.4. 2015-01-28 07:33:14 +00:00
Vinay Sajip db07164053 Added a logging cookbook entry on customized exception formatting. 2015-01-28 07:32:38 +00:00
Serhiy Storchaka 07985ef387 Issue #22286: The "backslashreplace" error handlers now works with
decoding and translating.
2015-01-25 22:56:57 +02:00
Ned Deily 99f7249264 Add missing URL link to Modernize docs. 2015-01-03 00:46:24 -08:00
Ned Deily 4592497f9d Add missing URL link to Modernize docs. 2015-01-03 00:45:55 -08:00
Benjamin Peterson 3226f9618f merge 3.4 2014-12-24 16:07:19 -06:00
Benjamin Peterson a54f07504f update correct French examples (#23109) 2014-12-24 16:07:02 -06:00
Benjamin Peterson 724bdce8b8 merge 3.4 (#23109) 2014-12-24 13:58:47 -06:00
Benjamin Peterson 643eb4464a improve incorrect French (#23109)
Following suggestions from Clément.
2014-12-24 13:58:05 -06:00
Berker Peksag e0f4bc7608 Issue #23047: Fix typo in pyporting.rst.
Patch by Chaitanya agrawal.
2014-12-13 15:49:01 +02:00
Berker Peksag bd62f0a6e4 Issue #23047: Fix typo in pyporting.rst.
Patch by Chaitanya agrawal.
2014-12-13 15:48:22 +02:00
Brett Cannon 5632aff9c1 Merge with 3.4 for porting HOWTO tweaks 2014-12-12 15:14:09 -05:00
Brett Cannon 90783ebf27 Address some comments from Nick Coghlan 2014-12-12 15:13:43 -05:00
Benjamin Peterson f615d1fe8e remove reference to dead irc channel (closes #23038) 2014-12-12 09:56:33 -05:00
Brett Cannon 17be09c475 Fix a bad link 2014-12-05 18:11:05 -05:00
Brett Cannon 6b335196c5 Issue #22914: Update the Python 2/3 porting HOWTO to describe a more
automated process.
2014-12-05 10:56:12 -05:00
Benjamin Peterson 8ac7cbb253 merge 3.4 2014-12-12 09:56:54 -05:00
Brett Cannon 9f7c7924c3 Merge with 3.4 2014-12-05 18:11:15 -05:00
Brett Cannon 1a7b8d1439 Merge with 3.4 2014-12-05 11:01:30 -05:00
Serhiy Storchaka 166ebc4e5d Issue #19676: Added the "namereplace" error handler. 2014-11-25 13:57:17 +02:00
Raymond Hettinger df1b699447 Issue #22823: Use set literals instead of creating a set from a list 2014-11-09 15:56:33 -08:00
Georg Brandl dbbc3a964b merge with 3.4 2014-10-30 22:52:06 +01:00
Georg Brandl 5aa761db52 pyporting howto: fix link target 2014-10-30 22:52:02 +01:00
Georg Brandl 6b4c847c4f Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:26:26 +01:00
Georg Brandl 93a56cdc37 Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:25:41 +01:00
Georg Brandl bad8d4bb53 merge with 3.4 2014-10-29 10:57:42 +01:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl 794e9bf1fe merge with 3.4 2014-10-29 10:27:06 +01:00
Georg Brandl 9bdcb3bc8a Fixing broken links in doc, part 2: howto/ 2014-10-29 09:37:43 +01:00
Georg Brandl 9e67d801bd merge with 3.4 2014-10-29 09:00:37 +01:00
Georg Brandl 728e4debd8 Fix external links to docs.python.org to use internal links instead. 2014-10-29 09:00:30 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl a3e80deac1 merge with 3.4 2014-10-28 21:38:54 +01:00
Georg Brandl 89c558da00 Closes #22748: there are no PyString C functions in 3.x. 2014-10-28 21:38:49 +01:00
Benjamin Peterson b91ed56b9b merge 3.4 2014-10-06 21:11:25 -04:00
Benjamin Peterson 57fb11b255 use source role instead of linking to svn 2014-10-06 21:10:25 -04:00
Berker Peksag 68e013cf0f Issue #13689: Merge from 3.4. 2014-07-01 06:03:24 +03:00
Berker Peksag fd6400a47d Issue #13689: Remove a dead link from howto/urllib. 2014-07-01 06:02:42 +03:00
Ezio Melotti 7b2ecc40a9 Merge socket howto fixes from 3.4. 2014-06-27 16:34:57 +03:00
Ezio Melotti 680241ec99 Fix indentation and class name in socket howto example. 2014-06-27 16:34:14 +03:00
Vinay Sajip 33683dfb25 Merged documentation update from 3.4. 2014-06-25 07:31:21 +01:00
Vinay Sajip ab960f838c Fixed typo in documentation. 2014-06-25 07:30:46 +01:00
Zachary Ware 9d91d0325c Merge typo fix from 3.4 2014-06-16 11:14:47 -05:00
Zachary Ware 0aecc18bab Fix typo reported by Jesse W on docs@ 2014-06-16 11:13:01 -05:00
Senthil Kumaran 38ee9afb34 merge from 3.4 2014-06-11 06:19:47 -07:00
Senthil Kumaran e9738239ba #21693 - Fix the broken link for pylons project. 2014-06-11 06:19:21 -07:00
Vinay Sajip 68b272b477 Merged documentation update from 3.4. 2014-06-02 00:31:44 +01:00
Vinay Sajip e81c637bf8 Updated logging HOWTO section on optimization. 2014-06-02 00:30:48 +01:00
Benjamin Peterson 3ecb1928cb merge 3.4 (#21586) 2014-05-26 15:11:11 -07:00
Benjamin Peterson 419f1fa9bc fix typo in variable name (closes #21586) 2014-05-26 15:10:42 -07:00
Donald Stufft 8b852f111e Fix Issue #21528 - Fix documentation typos 2014-05-20 12:58:38 -04:00
Raymond Hettinger ae4bab71e3 Don't grow strings by concatenation. Use ''.join() instead. 2014-05-18 21:02:25 +01:00
Benjamin Peterson 9e599673b4 fix off-by-one error (closes #21330) 2014-04-22 21:54:10 -04:00
Andrew Svetlov 08af00047b Get rid of deprecated IOError in the doc 2014-04-01 01:13:30 +03:00
Raymond Hettinger 4ab532bbfe Issue 21014: Use booleans instead of 0 and 1 in examples. 2014-03-28 16:39:25 -07:00
Vinay Sajip 4908910ab7 Updated external link in documentation. 2014-03-25 11:21:41 +00:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Benjamin Peterson bfca3ca114 fix typo (closes #20892) 2014-03-11 13:59:37 -05:00
Brett Cannon c39e892955 Issue #20813: Backport Python 2/3 HOWTO updates 2014-03-07 12:28:35 -05:00
Vinay Sajip d591cba9cf Merged documentation update from 3.3. 2014-02-03 11:52:24 +00:00
Vinay Sajip 554f22ff1d Added cookbook entry on logging filter configuration using dictConfig(). 2014-02-03 11:51:45 +00:00
Larry Hastings 7726ac9163 #Issue 20456: Several improvements and bugfixes for Argument Clinic,
including correctly generating code for Clinic blocks inside C
preprocessor conditional blocks.
2014-01-31 22:03:12 -08:00
Larry Hastings 0e25410319 Documentation fixes, including fixing "suspicious" problems. 2014-01-26 00:42:02 -08:00
Ezio Melotti a3642b67ca #20348: fix headers markup in Argument Clinic howto. Patch by Moritz Neeb. 2014-01-25 17:27:46 +02:00
Larry Hastings 42d9e1b9f3 Doc fixes for Argument Clinic. 2014-01-22 05:49:11 -08:00
Larry Hastings b7ccb20423 Issue #20294: Argument Clinic now supports argument parsing for __new__ and
__init__ functions.
2014-01-18 23:50:21 -08:00
Larry Hastings 537d760766 Doc improvements for Clinic howto "Goals" section. 2014-01-18 01:08:50 -08:00
Larry Hastings bebf73511a Issue #20287: Argument Clinic's output is now configurable, allowing
delaying its output or even redirecting it to a separate file.
2014-01-17 17:47:17 -08:00
Vinay Sajip 5714e815c9 Merged documentation update from 3.3. 2014-01-17 18:36:41 +00:00
Vinay Sajip eb14deca15 Added example to recently added cookbook entry. 2014-01-17 18:36:02 +00:00
Brett Cannon f0996a9970 Issue #20208: Clarify some things in the Python porting HOWTO.
Thanks to Rodrigo Bernardo Pimentel, Ondřej Čertík, and Dmitry
Shachnev for the feedback leading to the changes.
2014-01-17 11:45:01 -05:00
Larry Hastings 2a727916c5 Issue #20226: Major improvements to Argument Clinic.
* You may now specify an expression as the default value for a
  parameter!  Example: "sys.maxsize - 1".  This support is
  intentionally quite limited; you may only use values that
  can be represented as static C values.
* Removed "doc_default", simplified support for "c_default"
  and "py_default".  (I'm not sure we still even need
  "py_default", but I'm leaving it in for now in case a
  use presents itself.)
* Parameter lines support a trailing '\\' as a line
  continuation character, allowing you to break up long lines.
* The argument parsing code generated when supporting optional
  groups now uses PyTuple_GET_SIZE instead of PyTuple_GetSize,
  leading to a 850% speedup in parsing.  (Just kidding, this
  is an unmeasurable difference.)
* A bugfix for the recent regression where the generated
  prototype from pydoc for builtins would be littered with
  unreadable "=<object ...>"" default values for parameters
  that had no default value.
* Converted some asserts into proper failure messages.
* Many doc improvements and fixes.
2014-01-16 11:32:01 -08:00