Commit Graph

578 Commits

Author SHA1 Message Date
Serhiy Storchaka b8b9f95f66 [2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616)
* Use explicit numbering for footnotes referred by explicit number.
* Fix literal strings formatting in howto/urllib2.rst.
* Add `:noindex:` to duplicated definition of list.
* Update susp-ignored.csv for reference/expressions.rst.
(cherry picked from commit d97b7dc94b)
2017-05-17 01:26:48 +03:00
Mariatta e1b02ff588 [2.7] bpo-28315: Improve code examples in docs (GH-1372) (#1447)
Replace
   File "<stdin>", line 1, in ?
with
   File "<stdin>", line 1, in <module>.
(cherry picked from commit 8856940cf2)
2017-05-03 18:54:28 -07:00
Mariatta 24404b4c92 [2.7] bpo-30182: Use the correct name for ISO in Unicode HOWTO. (GH-1312). (#1315)
(cherry picked from commit 6fde770e4e)
2017-04-26 22:25:40 -07:00
Berker Peksag fb12365c43 Remove redundant comma in argparse HOWTO (GH-1141)
Reported by Sean Canavan on docs@p.o.

(cherry picked from commit 8526fb74ed)
2017-04-20 07:41:01 +03:00
Martin Panter ea9342ae6d Avoid line breaks after hyphens, otherwise they are turned into spaces 2017-01-14 09:53:23 +00:00
Brett Cannon 00ebffe5e1 Grammatical fixes for d95f19892fd0 2016-12-22 10:03:11 -08:00
Brett Cannon 37eb788e9e Update the porting HOWTO 2016-12-17 12:38:54 -08:00
Martin Panter a52b567a3f Issue #28820: Fix spelling of “practice” as a noun 2016-11-30 10:18:45 +00:00
Serhiy Storchaka 0092bc7279 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:39 +02:00
Martin Panter 3738ef4294 Change double hyphens (en dashes) to em (longer) dashes 2016-11-21 00:21:39 +00:00
Serhiy Storchaka e3d5787a25 Issue #19795: Mark up True and False as literal text instead of bold. 2016-10-19 16:43:18 +03:00
Serhiy Storchaka ad13f338ce Issue #19795: Mark up None as literal text. 2016-10-19 16:29:10 +03:00
Berker Peksag 6f959d07db Issue #26550: Fix typo in webservers HOWTO
Reported by Alejandro Soini.
2016-09-29 02:32:51 +03:00
Zachary Ware d379d6377f Issue #27204: Fix doctests in Doc/howto
Initial patch by Jelle Zijlstra.
2016-08-09 17:03:32 -05:00
Martin Panter 8f1dd224e0 Issue #26462: Doc: avoid literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Senthil Kumaran 75d7b615ba Prevent HTTPoxy attack (CVE-2016-1000110)
Ignore the HTTP_PROXY variable when REQUEST_METHOD environment is set, which
indicates that the script is in CGI mode.

Issue reported and patch contributed by Rémi Rampin.
2016-07-30 05:49:53 -07:00
Martin Panter a850ef698e Issue #27626: Spelling fixes in docs, comments and internal names
Based on patch by Ville Skyttä.
2016-07-28 01:11:04 +00:00
Martin Panter b362f75f6e Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
to fix the grammar.
2015-11-02 03:37:02 +00:00
Martin Panter fcd7d34afb Issue #25570: Add example of customizing User-Agent via add_header() 2016-06-01 08:20:22 +00:00
Martin Panter 200a615774 Issue #27125: Remove duplicated words from documentation and comments 2016-05-30 04:04:50 +00:00
Donald Stufft 5db0b3396e Fix Issue #21528 - Fix documentation typos 2014-05-20 12:58:38 -04:00
Serhiy Storchaka 12d547a80d Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 13:45:32 +03:00
Martin Panter f2f1c57b7e Fix typos in comments, documentation and test method names 2016-05-08 13:18:25 +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
Raymond Hettinger ff64b3a532 Issue #24715: Improve sort stability example 2016-04-26 01:09:32 -07:00
Benjamin Peterson bca06ccb3e fix python 3 mod init function declaration (closes #26827) 2016-04-22 23:43:10 -07:00
Serhiy Storchaka 9a118f1dc3 Issue #26778: Fixed "a/an/and" typos in code comment and documentation. 2016-04-17 09:37:36 +03:00
Berker Peksag 16b83b1f66 Issue #24173: Fix curses.wrapper link in curses HOWTO 2016-04-16 23:15:39 +03:00
Martin Panter 6a8163a928 Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
This affects documentation and code comments.
2016-04-15 02:14:19 +00:00
Serhiy Storchaka fdcb535893 Issue #25910: Fixed dead links in the docs. 2016-04-11 12:18:56 +03:00
Georg Brandl 6e0b44ef9e 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 cb7fff5ee3 Added a cookbook recipe for a logging context manager. 2016-04-01 23:06:57 +01:00
Georg Brandl 97b6e0bd1b Fix typo. 2016-02-28 21:09:36 +01:00
Vinay Sajip 35bb78ef7b Added simple threading example to logging cookbook. 2016-02-20 19:02:04 +00:00
Benjamin Peterson 51b13e53fc fix typo (closes #26378) 2016-02-17 23:42:46 -08:00
Martin Panter 53ae0ba6e3 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 9c61f2e45b Fix userinfo example presented in urllib2 howto. 2016-02-05 19:35:57 -08:00
Ezio Melotti 50ba447ab7 #25517: fix regex in the regex howto. Patch by Elena Oat. 2016-01-12 00:07:23 +02:00
Zachary Ware 2ee55f37c2 Fix use of default reST role 2015-11-05 10:28:18 -06:00
Serhiy Storchaka c72e66a048 Issue #25523: Backported a-to-an corrections. 2015-11-02 15:06:09 +02:00
Vinay Sajip 63173a8c7e Added entry to logging cookbook. 2015-10-17 13:55:19 +01:00
Vinay Sajip 9918775206 Closes #25344: Added cookbook recipe to show buffering of logging events. 2015-10-10 00:49:10 +01:00
Benjamin Peterson 1b822d0e2f use a more modern UA (#25145) 2015-09-20 23:16:45 +05:00
Benjamin Peterson c717e08720 remove reference to PyGoogle (#25145)
Patch by Bar Harel.
2015-09-20 23:17:41 +05:00
Vinay Sajip caaaa1413a Added a cookbook entry on logging audible messages. 2015-02-01 15:14:03 +00:00
Vinay Sajip 9e74fc3ee2 Added a logging cookbook entry on customized exception formatting. 2015-01-28 07:29:13 +00:00
Ned Deily b09ec90e9b Add missing URL link to Modernize docs. 2015-01-03 00:45:25 -08:00
Benjamin Peterson cb36d247a7 improve incorrect French (#23109)
Following suggestions from Clément.
2014-12-24 13:58:05 -06:00
Berker Peksag 0bf02c8df4 Issue #23047: Fix typo in pyporting.rst.
Patch by Chaitanya agrawal.
2014-12-13 15:51:18 +02:00
Brett Cannon fcf094c950 Backport of porting HOWTO 2014-12-12 15:15:49 -05:00