Commit Graph

20200 Commits

Author SHA1 Message Date
R David Murray 4ae4e7cbc0 #27753: fix typo (name->named). 2016-08-13 14:46:23 -04:00
Raymond Hettinger af0b38f814 Issue #27720: Fix error in eng_to_decimal docs and add examples from the specification. 2016-08-13 11:10:23 -07:00
Zachary Ware fa1ce08fc6 Issue #27205: Fix doctests in Doc/library/collections.rst 2016-08-09 17:28:33 -05: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 e2eacc02bc Issue #23943: Fix typos. Patch by Piotr Kasprzyk. 2016-07-28 03:04:04 +00:00
Zachary Ware 2955ef759e Issue #25393: Fix probable copy/paste error in resource docs
Patch by Alakshendra Yadav.
2016-07-19 16:41:20 -05:00
Martin Panter cdb8be4f40 Issue #27528: Document and test warning messages must match at beginning 2016-07-19 02:26:38 +00:00
Martin Panter bf2dca96fb English spelling and grammar fixes 2016-07-11 07:51:37 +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
Serhiy Storchaka 3626e5ef2a Issue #4945: Improved the documenting of boolean arguments in the json module.
Based on patch by Gabriel Genellina.
2016-06-30 13:58:58 +03:00
Victor Stinner bc44893155 Issue #27416: clarify copy doc
Patch written by R. David Murray.
2016-06-30 11:50:23 +02:00
Martin Panter aaa4baf4e5 Issue #27370: Use t for an iterable in mutable sequence ops 2016-06-23 00:53:05 +00:00
Senthil Kumaran 8da85a173a Fix the urllib.parse.urljoin docs. Reported by Bo Bayles in docs list. 2016-06-22 00:56:22 -07:00
Martin Panter 4e6e565368 Fix English spelling and grammar errors 2016-06-20 07:52:50 +00:00
Serhiy Storchaka 4183387e79 Issue #27294: Numerical state in the repr for Tkinter event objects is now
represented as a compination of known flags.
2016-06-18 22:08:49 +03:00
Martin Panter d51b0f2188 Issue #24314: Add links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Georg Brandl b311eeefb8 Docs: add html-stable autobuild variant 2016-06-15 08:57:32 +02:00
Martin Panter 0e212331ea Issue #12855: Document what exactly unicode.splitlines() splits on
Also synchronize with Python 3 examples. Based on patches by Matthew Boehm
and Alexander Schrijver.
2016-06-01 09:39:46 +00:00
Martin Panter fc0a55fed9 Issue #16182: Backport documentation of set_pre_input_hook() availability 2016-06-14 08:45:43 +00:00
Berker Peksag 0d8657721e Issue #15657: Delete incorrect statement from PyMethodDef documentation 2016-06-12 16:37:57 +03:00
Martin Panter 056cbfdc51 Fix typo in documentation 2016-06-12 06:14:03 +00:00
Martin Panter e52140caf1 #16484: Change PYTHONDOCS to "https:", and fix links to use lowercase
Implementation by Sean Rodman; test by Kaushik Nadikuditi.
2016-06-12 05:25:16 +00:00
Martin Panter be2bb472b0 Issue #16484: PYTHONDOCS still uses “http:” in Python 2 2016-06-12 04:38:34 +00:00
Tommy Beadle 33b19ca77f Issue #24617: Add comment for os.mkdir about mode quirks 2016-06-02 15:41:20 -04:00
Martin Panter c9813d83f7 Issue #20699: Document that “io” methods should accept memoryview
This matches the usage by BufferedReader, BufferedWriter, etc. Also document
and test that the write() methods should only access their argument before
they return.
2016-06-03 05:59:20 +00:00
Martin Panter d6cecd30af Issue #8491: Add link to Gnu Readline configuration documentation 2016-06-10 00:27:46 +00:00
Tommy Beadle 24b9e1a00d [Issue 15476] Make "code object" its own entry in the index 2016-06-02 19:26:51 -04:00
Martin Panter d5982d0433 Issue #23275: Backport empty square bracket assignment documentation fix 2016-06-08 12:44:30 +00:00
Martin Panter 6af1c49bb4 Issue #25738: Don’t send message body for 205 Reset Content
Patch by Susumu Koshiba.
2016-06-08 07:16:14 +00:00
Ned Deily 835d392d8a Issue #26014: Guide 2.7 users to the new packaging documentation:
- the top-level 2.7 docs page now links to the newer doc pages
  (installing and distribution) rather than the legacy ones
- the legacy install and distutils pages are now labeled as "legacy"
- the library/distutils page is updated to match the 3.x version
- "See also" links to the new docs are now provided in the legacy pages
- links to setuptools documentation have been updated

(original patch by Susan Sun)
2016-06-05 17:35:43 -07:00
Ned Deily 06cd1c3d36 Issue 27216: Fix typo (noticed by Alex Chan). 2016-06-04 09:39:42 -07:00
Senthil Kumaran e6167e33e6 [backport to 2.7] - issue8519 - Reference termios and ioctl manual pages in the library documentation. 2016-06-02 23:51:22 -07:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) c3cd60e764 issue25931: document that socketserver.Forking* are unavailable on platforms
that support os.fork.
2016-06-03 05:48:23 +00:00
R David Murray 3017cef009 #13784: fix xml.sax.reader getColumn/LineNumber docs.
verification and patch by Emily Morehouse.
2016-06-02 15:13:37 -04:00
Benjamin Peterson 382d041131 note that Py_VISIT handles NULL (closes #27183) 2016-06-02 11:35:59 -07:00
Berker Peksag 56da8fa581 Issue #12243: Remove redundant availability notes from getpass docs
I wonder why I keep forgetting 2.7 :P

Patch by Bryce Verdier.
2016-06-01 18:32:42 -07: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
Senthil Kumaran 739b3737f2 issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.
Patch contributed by Nathan Harold.
2016-05-29 20:38:55 -07:00
Martin Panter b44c4520d9 Issue #27125: Fix various errors like “will [be] inherited” 2016-05-29 08:13:58 +00:00
Raymond Hettinger cb0fc27f20 Issue 25926: Clarify that the pure python equivalents are only approximate. 2016-05-28 00:26:41 -07:00
Martin Panter 5720493172 Issue #26553: Capitalization of HTTP, HTTPS, FTP, and URL
Patch by Anish Shah and Aatish Neupane.
2016-05-28 02:33:05 +00:00
Martin Panter 6ecfab85d9 Issue #5784: Cannot test wbits=0 unless we know we have zlib v1.2.3.5 2016-05-27 11:20:21 +00:00
Martin Panter 9c946bbf20 Issue #5784: Expand documentation and tests for zlib wbits parameter
Based on documentation by AM Kuchling.
2016-05-27 07:32:11 +00:00
Benjamin Peterson 5541aa35d0 stop talking about svn 2016-05-26 23:18:51 -07:00
Benjamin Peterson 496790b541 remove cruft from Schwarzian transform section 2016-05-26 22:55:49 -07:00
Benjamin Peterson 01d2580d4b "Numeric Python" -> "NumPy" 2016-05-26 22:51:32 -07:00
Donald Stufft 5db0b3396e Fix Issue #21528 - Fix documentation typos 2014-05-20 12:58:38 -04:00
Georg Brandl 171deb279c #5486: typos. 2009-03-13 19:04:40 +00:00
Georg Brandl 880e4f3ca1 #9911: doc copyedits. 2010-09-21 14:48:28 +00:00
Eli Bendersky 658903e1ad Fix typo in library/ipc.rst 2014-02-09 05:54:13 -08: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 4f23cabc16 Corrections for a/an in code comments and documentation 2016-05-08 13:45:55 +00:00
Martin Panter f2f1c57b7e Fix typos in comments, documentation and test method names 2016-05-08 13:18:25 +00:00
Martin Panter cdbf38cbd6 Issue #26512: Clarify Integral; tidy up table of rounding functions
Based on patch by Julien.
2016-05-08 12:47:37 +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
Serhiy Storchaka c145da0751 Issue #26889: Fixed hyperlinks formatting. 2016-05-07 10:06:53 +03:00
Serhiy Storchaka 63d2fca866 Issue #26889: Tweaked xmlrpclib documentation. 2016-05-07 08:44:58 +03:00
Berker Peksag 1ca93b621c Issue #26962: Backport 23d986228c6b to 2.7 2016-05-05 11:05:49 +03:00
Terry Jan Reedy 7d03c84634 Clarify IDLE-console differences with respect to the sys module.
The reload(sys) effect was the crux of a Stackoverflow question.
2016-05-02 18:17:19 -04:00
Berker Peksag 065b40c0bd Issue #21746: Remove BaseResult reference from urlparse documentation
BaseResult no longer exists and it has been replaced by namedtuple.

Patch by Matthew Gilson.
2016-04-30 18:36:31 +03:00
Serhiy Storchaka 44f99d0aaf fileinput.hook_encoded() uses io.open(), not codecs.open(). 2016-04-27 23:07:25 +03:00
Berker Peksag b6886505a6 Issue #26672: Fix regrtest example in test.rst
Reported by Axel Luttgens.
2016-04-27 08:58:32 +03:00
Martin Panter 11cc513e8b Issue #20598: Replace trivial split() calls with lists in argparse docs 2016-04-26 11:33:46 +00:00
Raymond Hettinger ff64b3a532 Issue #24715: Improve sort stability example 2016-04-26 01:09:32 -07:00
Raymond Hettinger 167c81d5ed Issue #23986: Note that the in-operator for lists and tuples check identity before equality. 2016-04-26 00:59:16 -07:00
Senthil Kumaran b31c87bfcf backport fix for Issue #26804.
urllib.request will prefer lower_case proxy environment variables over
UPPER_CASE or Mixed_Case ones.
2016-04-25 09:17:54 -07:00
Benjamin Peterson bca06ccb3e fix python 3 mod init function declaration (closes #26827) 2016-04-22 23:43:10 -07:00
Martin Panter 5b48fa9fa4 Fix spelling (inital), grammar (may translates) in documentation, comments 2016-04-19 04:03:41 +00: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 bf02d18844 Fix typos in code comment and documentation 2016-04-16 09:28:57 +00:00
Martin Panter fb45216da8 Issue #26638: Fix links to some CLI options
Disable inappropriate links to Python interpreter options. Also make CLI
section label in timeit less ambiguous.
2016-04-16 04:59:38 +00:00
Martin Panter 87d9de6354 Issue #25314: Remove confused statement about const argument 2016-04-09 03:49:48 +00: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
Berker Peksag a364c12042 Issue #26747: Document that InstanceTypes only works for old-style classes
Patch by Nan Wu.
2016-04-14 15:51:22 +03:00
Georg Brandl b9b98c81fd Update susp-ignore file (#25910). 2016-02-28 21:13:23 +01:00
Martin Panter d47b99643b Issue #25496: Document compresslevel defaults to 9, by Hamza T Khan 2016-04-13 03:24:06 +00:00
Georg Brandl 5892ab1b4a Clarify greedy-qualifier example, avoid HTML. 2016-04-12 07:51:41 +02:00
Serhiy Storchaka 92a5f47d2c Issue #25910: Fixed more links in the docs. 2016-04-11 17:32:33 +03: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
Martin Panter aad86a6015 Issue #6953: Rearrange and expand Readline module documentation
* Group functions into six new subsections
* Document the underlying Readline function or variable accessed
* get_history_length() returns the history file limit
* clear_history() is conditionally compiled in
* Clarify zero and one bases for history item indexes
* parse_and_bind() uses its argument directly as an init line
* Change "command line" to "line buffer" for consistency
* read_init_file() also executes the file
* read_history_file() replaces the previous history
* write_history_file() overwrites any existing file
* Differentiate history file lines from history list items, which could be
  multi-line
* Add more information about completion, also addressing Issue #10796
* libedit (Editline) may be used on any platform; detection is OS X specific
2016-04-05 07:37:22 +00:00
Martin Panter ce9f8e2492 Issue #26678: Fix datetime.tzinfo indexing and “tzinfo” attribute links 2016-04-01 21:48:24 +00:00
Vinay Sajip cb7fff5ee3 Added a cookbook recipe for a logging context manager. 2016-04-01 23:06:57 +01:00
Serhiy Storchaka 838b1339e8 Remove redundant leading zeroes in PEP references. 2016-03-31 15:31:04 +03:00
Terry Jan Reedy 127f0d85e4 Issue #15660: Further clarify 0 prefix for width specifier in formats. 2016-03-20 21:05:50 -04:00
Nick Coghlan dbcd457624 Issue #23857: Implement PEP 493
Adds a Python-2-only ssl module API and environment variable to
configure the default handling of SSL/TLS certificates for
HTTPS connections.
2016-03-20 22:39:15 +10:00
Ezio Melotti 3a4bdb6322 #26250: document the sqlite3.Cursor.connection attribute. Initial patches by Aviv Palivoda and Varpu Rantala. 2016-03-18 20:10:36 +02:00
Ezio Melotti aac1dd0429 #24918: fix CSS for code blocks when a side box is present. Patch by Manvi B. 2016-03-13 11:42:05 +02:00
Ezio Melotti 6066257c38 #25687: clarify that errors in tearDown increase the total number of reported errors. Initial patch by HyeSoo Park. 2016-03-13 09:40:09 +02:00
Ezio Melotti 3d3a8f6c7b #26247: document Chrome/Chromium addition to webbrowser. Patch by Manvi B. 2016-03-11 21:32:12 +02:00
Victor Stinner 498834b7b9 Fix inspect.ismethod() doc
Closes #16851: Fix inspect.ismethod() doc, return also True if object is an
unbound method.

Patch written by Anna Koroliuk.
2016-03-11 11:27:46 +01:00
Serhiy Storchaka 69b7f812fa Issue #15068: Got rid of excessive buffering in the fileinput module.
The bufsize parameter is no longer used.
2016-03-08 18:35:45 +02:00
Ned Deily 69d7f6a6a7 Issue #26505: Fix typos in getaddrinfo license text.
Patch by Alex Willmer.
2016-03-07 14:51:19 -05:00
Raymond Hettinger 2ec5fd546f Document another recipe for itertools: all_equal(). Inspired by David Beazley. 2016-03-06 18:06:29 -08:00
Berker Peksag e41dc4f7bc Issue #26485: Fix Sphinx warning in Doc/license.rst
Patch by Julien.
2016-03-05 13:55:04 +02:00