Commit Graph

20294 Commits

Author SHA1 Message Date
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
Gregory P. Smith deffc0be4b issue26484 - fix the broken table in the doc about len(). 2016-03-04 16:32:36 -08:00
Berker Peksag bb569362f4 Issue #26246: Set initial value of the hidden attr when creating copy button.
Patch by Liang-Bo Wang.
2016-03-02 19:44:24 +02:00
Georg Brandl 97b6e0bd1b Fix typo. 2016-02-28 21:09:36 +01:00
Raymond Hettinger 5a3e8e5bc0 Issue 13573: Document that csv.writer uses str() for floats instead of repr(). 2016-02-27 23:34:54 -08:00
Martin Panter ef85a1ac15 Issue #22836: Keep exception reports sensible despite errors 2016-02-28 00:18:43 +00:00
Ezio Melotti f9ce84b195 #26246: update copybutton.js after JQuery update. Patch by Liang-Bo Wang. 2016-02-27 08:39:36 +02:00
Georg Brandl a575839f25 Fix rstlint to also look for indented comments that should be directives. 2016-02-25 20:14:10 +01:00
Martin Panter 39267c21cc Issue #22088: Clarify base-64 alphabets and which characters are discarded
* There are only two base-64 alphabets defined by the RFCs, not three
* Due to the internal translation, plus (+) and slash (/) are never discarded
* standard_ and urlsafe_b64decode() discard characters as well
2016-02-23 22:30:50 +00:00
Martin Panter be9ddc1d11 Issue #26261: Clarify NamedTemporaryFile name attribute vs file.name 2016-02-22 10:10:00 +00:00
Martin Panter 3e85838ee9 Fix errors in XML-RPC client example code
* httplib.HTTP (deprecated and does not work) → HTTPConnection
* Server (deprecated) → ServerProxy
2016-02-22 09:10:54 +00:00
Vinay Sajip 35bb78ef7b Added simple threading example to logging cookbook. 2016-02-20 19:02:04 +00:00
Martin Panter 59b9a16e72 Issues #22468, #21996, #22208: Clarify gettarinfo() and TarInfo usage
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
  files may need special care
* Filename taken from fileobj.name; suggest dummy arcname as a workaround
* Indicate TarInfo may be used directly, not just via gettarinfo()
2016-02-19 23:34:56 +00:00
Georg Brandl d6dd0e6560 Closes #20169: fix inner links random doc. 2016-02-19 08:57:23 +01:00
Martin Panter 94035f3aa7 Issue #15608: Improve socketserver module documentation
* Add headings for each concrete and mix-in class and list methods and
  attributes under them
* Fix class and method cross references
* Changed RequestHandler to BaseRequestHandler and added class heading
* Pull out Stream/DatagramRequestHandler definitions
* Reordered the request handler setup(), handle(), finish() methods
* Document constructor parameters for the server classes
2016-02-19 03:27:46 +00:00
Benjamin Peterson 51b13e53fc fix typo (closes #26378) 2016-02-17 23:42:46 -08:00
Georg Brandl c665ff6177 Closes #26320: fix stylesheet after Sphinx update. 2016-02-10 13:44:29 +01: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
Martin Panter 2dafcc25a9 Issues #26310, #26311: Fix typos in the documentation 2016-02-10 01:17:51 +00:00
Gregory P. Smith 3b5d61fa6c Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:59:14 -08:00
Serhiy Storchaka 36ae29c759 Issue #26198: Fixed error messages for some argument parsing errors.
Fixed the documented about buffer overflow error for "es#" and "et#" format
units.
2016-02-08 01:05:48 +02:00
Martin Panter 00f19eff3e Issue #25179: Preparatory cleanup of existing docs on string formatting
* There was a link pointing to the section on the string.Formatter class (and
  multiple links in Python 3), when the section on the common format string
  syntax is probably more appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested in Python 3; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Senthil Kumaran 9c61f2e45b Fix userinfo example presented in urllib2 howto. 2016-02-05 19:35:57 -08:00
Zachary Ware bf3b89782f Python for .NET has moved to Github.
Reported by Denis Akhiyarov on docs@
2016-02-03 22:05:46 -06:00
Martin Panter 1d269c1067 Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
2016-02-03 07:06:33 +00:00
Martin Panter a339e86dc0 Issue #19023: Document ctypes array and pointer classes
Also add some more tests. Based on patch by Sye van der Veen.
2016-01-29 10:12:19 +00:00
Berker Peksag b031adcd51 Fix typo in test.rst
Reported by Mike Scalora on docs@p.o.
2016-01-25 08:24:57 +02:00
Victor Stinner b4929843a9 doc: i18n HTML templates
Issue #25907: Use {% trans %} tags in HTML templates to ease the translation of
the documentation. The tag comes from Jinja templating system, used by Sphinx.

Patch written by Julien Palard.
2016-01-23 12:55:11 +01:00
Gregory P. Smith 20d4f1b9e4 Per issue21949 and issue1629: Document the Py_SIZE, Py_TYPE, Py_REFCNT macros.
This was already done in the 3.5 branch; this just does the same in the 2.7
branch.
2016-01-22 13:17:41 -08:00
Berker Peksag f9aa599c0a Issue #18620: Improve Pool examples in multiprocessing documentation
A single call to Pool.apply_async() will create only one process. To use all
of the pool's processes, it should be invoked multiple times:

    with Pool(processes=4) as pool:
        results = [pool.apply_async(func, ()) for i in range(4)]

Patch by Davin Potts.
2016-01-22 00:07:00 +02:00
Victor Stinner 047ddfb64d Issue #26106: doc: Move text of licenses to parsed literal block
This change helps to ignore text of PSF, BEOPEN.com and CNRI licenses when
translating the documentation. Patch written by Julien Palard who is
translating Python 3.5 doc to french. Text of other licenses already used
preformatted format.
2016-01-21 08:56:00 +01:00
Senthil Kumaran 762d761d65 issue25982 - Add a class definition for managers.Namespace in the multiprocessing docs. 2016-01-20 03:18:48 -08:00
Senthil Kumaran 5e90cd9b32 Issue26017 - Suggest enclosing command args in double quotes when using characters which get interpreted by shell. 2016-01-17 18:45:11 -08:00
Senthil Kumaran e57c957ff9 Issue26142 - Fix a formatting bug in c-api intro doc. 2016-01-17 17:05:14 -08:00
Senthil Kumaran 11a73890d3 Issue26035 - Correct the argument names used in the docs of the traceback module. Make it consistent with module args. 2016-01-15 22:13:16 -08:00
Martin Panter 264dcb7290 Issue #26127: Fix links in tokenize documentation 2016-01-16 04:32:52 +00:00
Senthil Kumaran 1826f6369c Issue26097 - Fix the TextTestRunner documentation, mention all the arguments of the class.
Patch contributed by Nicolas Évrard.
2016-01-14 21:57:57 -08:00
Ezio Melotti 4cb7fca89f #25574: backport glossary doc fix about hash and id of user-defined classes. 2016-01-12 11:36:25 +02:00
Ezio Melotti 7f62062be1 #19006: fix wording in unittest docs. 2016-01-12 11:03:10 +02:00
Ezio Melotti 50ba447ab7 #25517: fix regex in the regex howto. Patch by Elena Oat. 2016-01-12 00:07:23 +02:00
Ezio Melotti 167c336725 #25991: fix readline example to limit history size. Patch by Daniel Dye. 2016-01-11 23:30:15 +02:00
Benjamin Peterson c2ccb73e8a delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Senthil Kumaran 145b1c6c2a Issue23675 - A tiny clarification in the MRO glossary term. 2016-01-09 22:36:13 -08:00
Senthil Kumaran ee98860e5f Issue20969 - Set the Epub Author and Epub Publisher in Python docs. 2016-01-08 01:05:57 -08:00
Benjamin Peterson c6fa90c7ca fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Berker Peksag 6b51ddfa22 Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has no effect
Patch by Davin Potts and Camilla Montonen.
2016-01-07 18:49:53 +02:00
Senthil Kumaran 788db63265 Fix issue18918 : Attach the pydoc documentation for 'FILES' topic.
Also rebuilt the pydoc_data with this change.
2016-01-06 03:54:18 -08:00
Senthil Kumaran e2e6b54a4c Backport documentation improvement.
Issue24898 - Improve str.find documentation.

Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 18:07:06 -08:00
Senthil Kumaran 8a4e7fd678 Backport doc improvements for Issue21221 - Explain the usage of tm_isdst
attribute of mktime, with valid values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 01:03:40 -08:00
Zachary Ware fa45a0e3d2 Fix grammar.
Reported by Anatoly Techtonik on docs@
2016-01-01 12:22:16 -06:00
Benjamin Peterson f30bad284b remove some copyright notices supserseded by the toplevel ones 2016-01-01 11:53:47 -06:00
Benjamin Peterson 1f40ece2d7 2016 will be another year of writing copyrighted code 2016-01-01 10:23:45 -06:00
Martin Panter d77fe94b4e Issue #22088: Port base64 character ignoring doc and test from 857d9fe60169 2015-12-14 03:41:59 +00:00
Martin Panter edd6a817d1 Issue #20837: Base-64 alphabet clarification from revision 1853679c6f71 2015-12-14 02:54:40 +00:00
R David Murray b75adccd0a #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:14 -05:00
Zachary Ware 6b93ca6a3b Clarify that only *documentation* bugs should go to docs@python.org 2015-12-09 01:53:44 -06:00
Vinay Sajip c9625c8e4b Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:18:30 +00:00
Martin Panter 402803b642 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00
Martin Panter 793ae0d0ae Issue #20468: Remove incorrect information about maxrss and page size
Extract of patch by Ronald Oussoren.
2015-11-17 22:13:47 +00:00
Martin Panter a5d1cf3221 Issue #25615: Document unsorted behaviour of glob; patch by Dave Jones 2015-11-16 23:46:22 +00:00
Martin Panter 5118f7b9af Issue #25017: Document that htmllib is superseded by module HTMLParser 2015-11-14 00:30:46 +00:00
Victor Stinner c0fdd825c2 Issue #25605: Document exceptions raised by fcntl.ioctl() and fcntl.flock() 2015-11-13 09:13:16 +01:00
Zachary Ware db7a1d6e15 Document the BUILD_SET opcode.
Reported by Hrvoje Abraham on docs@.
2015-11-12 10:02:06 -06:00
Zachary Ware 77d61d4156 Rewrite re.VERBOSE section.
It now has slightly better rationale and a less awkward wording in the
explanation.

Inspired by a report of a neither/or conflict by 'animalize' on docs@.
2015-11-11 23:32:14 -06:00
Zachary Ware 2ee55f37c2 Fix use of default reST role 2015-11-05 10:28:18 -06:00
Benjamin Peterson be038077fb remove trailing ws 2015-11-03 22:43:31 -08:00
Benjamin Peterson 40559cedb5 merge heads 2015-11-03 22:42:08 -08:00
Benjamin Peterson 873cad2f16 link to modern PUG url 2015-11-03 22:42:02 -08:00
Serhiy Storchaka c72e66a048 Issue #25523: Backported a-to-an corrections. 2015-11-02 15:06:09 +02:00
Terry Jan Reedy a5ad9da504 Issue #25519: Mark difflib.ndiff as a functions where not already. 2015-10-30 19:41:10 -04:00
Terry Jan Reedy 0a1ba70949 Issue #25432: Explain isinstance behaviour when type is a tuple. 2015-10-28 03:14:46 -04:00
Victor Stinner 15a43ed030 Issue #25461: Rephrase os.walk() doc
Patch written by Bernt Røskar Brenna.
2015-10-23 12:42:39 +02:00
Vinay Sajip 63173a8c7e Added entry to logging cookbook. 2015-10-17 13:55:19 +01:00
Terry Jan Reedy 1c49ec0df0 Issue #24782: Finish converting the Configure Extension dialog into a new
tab in the IDLE Preferences dialog.  Code patch by Mark Roseman.
2015-10-13 22:03:44 -04:00
Benjamin Peterson a20c72a264 actually link to the version attributes documentation 2015-10-11 23:03:22 -07:00
Benjamin Peterson d2a19c2c67 don't mention Python 2.2 (closes #25375) 2015-10-10 23:23:55 -07:00
Martin Panter 4ed35fc4f3 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:52:35 +00:00
Martin Panter dab305ef05 Issue #22413: Document newline effect on StringIO initializer and getvalue
Also add to comment in the C code.
2015-10-10 02:52:30 +00:00
Vinay Sajip 9918775206 Closes #25344: Added cookbook recipe to show buffering of logging events. 2015-10-10 00:49:10 +01:00
Martin Panter 840c82ee88 Issue #25286: Accidentally dropped "the" 2015-10-07 10:39:13 +00:00
Martin Panter 4a33724d47 Issue #25286: Dictionary views are not sequences
Also change glossary heading from "view" to "dictionary view". Patch by Akira
Li.
2015-10-07 10:19:39 +00:00
Martin Panter fcf58a1518 Issue #16701: Document += and *= for mutable sequences 2015-10-03 07:37:22 +00:00
Terry Jan Reedy 195fc2f2aa Issue #25224: README.txt is now an idlelib index for IDLE developers and
curious users.  The previous user content is now in the IDLE doc and is
redundant.  IDLE now means 'Integrated Development and Learning Environment'.
2015-10-02 23:22:54 -04:00
Terry Jan Reedy 958a9c7520 Issue #24028: Add subsection about Idle calltips. 2015-09-29 01:55:50 -04:00
Benjamin Peterson 02dc7d1272 merge heads 2015-09-27 02:08:04 -07:00
Berker Peksag 9fa7e2e5ef Fix broken link in Doc/extending/index.rst 2015-09-27 12:06:26 +03:00
Benjamin Peterson 4e648f6c07 make wikipedia link https 2015-09-27 02:05:01 -07:00
Benjamin Peterson 9b4865ad2b shorten and fix casing of title 2015-09-27 01:23:10 -07:00
Terry Jan Reedy f56f8d1800 Issue #25225: Condense and rewrite Idle doc section on text colors. 2015-09-24 23:13:43 -04:00
Terry Jan Reedy 7cca4e5ba2 Issue 21995: Explain some differences between IDLE and console Python. 2015-09-24 03:09:38 -04:00
Victor Stinner 68dafe5f14 Issue #24894: Document the codec iso8859_11
Patch written by Prashant Tyagi.
2015-09-24 09:05:19 +02:00
Terry Jan Reedy cf5bf82e59 Issue #22820: Explain need for *print* when running file from Idle editor. 2015-09-24 01:39:25 -04:00
Terry Jan Reedy 6741a5ae19 Issue 25224: Augment Idle doc feature list and no-subprocess section
to finish making current README.txt obsolete.
2015-09-23 20:00:22 -04:00
Terry Jan Reedy c7025c6265 Issue #25219: Update doc for Idle command line options.
Some were missing and notes were not correct.
2015-09-23 03:52:18 -04:00
Berker Peksag 0612ae52a0 Issue #23484: Document differences between synchronization primitives of
threading and multiprocessing modules.

In multiprocessing, the name of the first parameter of the acquire methods is
"block", but "blocking" in threading.

This commit also improves documentation of Lock and RLock.

Patch by Davin Potts.
2015-09-21 07:15:52 +03: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
Ethan Furman b85154fa37 Issue24756: clarify usage of run_docstring_examples() 2015-09-17 22:19:48 -07:00
Benjamin Peterson 061653091e fix name of argument in docstring and the docs (closes #25076)
Patch by TAKASE Arihiro.
2015-09-12 17:20:47 -07:00
Serhiy Storchaka 9b2e37f688 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:47:12 +03: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
Zachary Ware d0384044ee Fix grammatical error in csv docs.
Reported by Nat Dunn on docs@
2015-09-11 10:51:47 -05:00
Martin Panter 6f80464f4a Issue #25030: Do not document seek() as if it accepts keyword arguments
Patch from Shiyao Ma.
2015-09-11 03:58:30 +00:00
Martin Panter 397c2103f7 Issue #25022: Avoid warning about unused suspicious rule 2015-09-11 02:45:10 +00:00
Zachary Ware 677688be22 Issue #25022: Add NEWS, fix docs to not mention the old example. 2015-09-10 15:50:58 -05:00
Guido van Rossum d076454bd3 Add the original author of profile.py back to the docs, at his request. 2015-09-10 12:11:17 -07:00
Martin Panter 0ed1bcdff8 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 01:40:33 +00:00