Commit Graph

7256 Commits

Author SHA1 Message Date
Victor Stinner d0d5154251 Update fcntl doc: replace IOError with OSError
Issue #26716. IOError is a deprecated alias to OSError since Python 3.3.
2016-04-09 11:32:58 +02:00
Brett Cannon 09455589c7 Issue #26587: Remove an incorrect statement from the docs 2016-04-08 15:06:54 -07:00
Martin Panter 0f7673943a 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 cc71a795df Fix typos in documentation and comments 2016-04-05 06:19:42 +00:00
Berker Peksag af8363926a Issue #26679: Fix description of KEY_PPAGE and KEY_NPAGE constants
Patch by Robert Bachmann and SilentGhost.
2016-04-02 04:48:27 +03:00
Berker Peksag b31daff1f7 Issue #26688: Fix module name in mock docs
Patch by Ashley Anderson.
2016-04-02 04:32:06 +03:00
Martin Panter 16c7cfda7c Issue #26678: Fix indexing of datetime.tzinfo and timezone classes
Also fix links to the “tzinfo” class and attributes.
2016-04-01 21:48:24 +00:00
Serhiy Storchaka e4ba872543 Remove redundant leading zeroes in PEP references. 2016-03-31 15:30:54 +03:00
Berker Peksag 13b3acd13e Fix typo in xml.dom.pulldom.rst
Reported by Matthew Cole on docs@p.o.
2016-03-30 16:28:43 +03:00
Andrew Svetlov 6f57424ae0 Document None as timeout for asyncio.timeout() 2016-03-29 09:39:02 +03:00
Raymond Hettinger f9cddccf8c Issue #25314: store_true and store_false also create appropriate defaults. 2011-11-20 11:05:23 -08:00
Martin Panter f6b1d66a3c Issue #23804: Fix SSL recv/read(0) to not return 1024 bytes 2016-03-28 00:22:09 +00:00
Berker Peksag fa0f62d6ab Issue #23758: Improve num_params docs of create_{function,aggregate} functions
If you pass -1, the callable can take any number of arguments.

Added tests to verify the behavior.

Initial patch by Cédric Krier.
2016-03-27 22:39:14 +03:00
Berker Peksag f70fe6f6cf Document sqlite3.Cursor.close()
The behaviour of the close method is tested by ClosedCurTests
in Lib/sqlite3/test/dbapi.py.

This is basically a backport of https://github.com/ghaering/pysqlite/issues/73.
2016-03-27 21:51:02 +03:00
Berker Peksag 557a06309c sqlite3 documentation: Connection.iterdump() is a method 2016-03-27 18:46:18 +03:00
Victor Stinner 8a20851010 Issue #25654:
* multiprocessing: open file with closefd=False to avoid ResourceWarning
* _test_multiprocessing: open file with O_EXCL to detect bugs in tests (if a
  previous test forgot to remove TESTFN)
* test_sys_exit(): remove TESTFN after each loop iteration

Initial patch written by Serhiy Storchaka.
2016-03-25 09:29:50 +01:00
Terry Jan Reedy 01a9a958b6 Issue #26525: Change chr example to match change in ord example. 2016-03-23 13:36:52 -04:00
Terry Jan Reedy 063d48d9c0 Issue #26525: Change ord example from nu to more easily recognized Euro sign. 2016-03-20 21:18:40 -04:00
Terry Jan Reedy 4902c46bff Issue #15660: Further clarify 0 prefix for width specifier in formats. 2016-03-20 21:05:57 -04:00
Ezio Melotti 62564dbb4b #26250: document the sqlite3.Cursor.connection attribute. Initial patches by Aviv Palivoda and Varpu Rantala. 2016-03-18 20:10:36 +02:00
Serhiy Storchaka 774006232a Fixed a typo. 2016-03-18 14:36:47 +02:00
Berker Peksag 42f8548c89 Issue #26580: Remove outdated reference to ftpmirror
Patch by SilentGhost.
2016-03-18 14:26:08 +02:00
Martin Panter ce911c3fed Issue #26499: Fixes to HTTPResponse.readline() and read1(), by Silent Ghost 2016-03-17 06:42:48 +00:00
Raymond Hettinger a503f7092f Minor recipe edit: convert "while 1" to "while True". 2016-03-13 00:12:31 -08:00
Ezio Melotti 8dea74f12a #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
Raymond Hettinger 4d02896609 Issue #26548: Minor fix to awkward wording in docs 2016-03-12 22:58:24 -08:00
Steve Dower d669b6bd0a Issue #23606: Adds note to ctypes documentation regarding cdll.msvcrt. 2016-03-12 08:25:22 -08:00
Berker Peksag eb2e02bed4 Issue #26542: Fix markup of code example in difflib documentation
Patch by Dmitry Shachnev.
2016-03-11 23:19:48 +02:00
Serhiy Storchaka cc2dbc5844 Issue #15068: Got rid of excessive buffering in the fileinput module.
The bufsize parameter is no longer used.
2016-03-08 18:28:36 +02:00
Berker Peksag 777d639a92 Issue #21034: Remove outdated paragraph from venv documentation
Since Python 3.4, there is no need to install pip and setuptools
into a venv manually.
2016-03-07 18:50:49 +02:00
Raymond Hettinger e525ee3b48 Document another recipe for itertools: all_equal(). Inspired by David Beazley. 2016-03-06 18:11:38 -08: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
Georg Brandl 32fbd3a623 Closes #26442: fix copy-paste. 2016-02-26 19:16:40 +01:00
Georg Brandl adeffcc2f9 Closes #26444: typo fixes. 2016-02-26 19:13:47 +01:00
Martin Panter bc85e35fe6 Issue #26390: Fix and test pbkdf2_hmac() parameter names
Based on patch by Daan Bakker.
2016-02-22 09:21:49 +00:00
Georg Brandl 8c16cb9f65 Closes #26435: fix syntax in directives. Thanks to Jakub Stasiak. 2016-02-25 20:17:45 +01:00
Martin Panter ee3074e1f4 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

Also update the doc strings to clarify data types, based on revision
92760d2edc9e, correct the exception raised by b16decode(), and correct the
parameter name for the base-85 functions.
2016-02-23 22:30:50 +00:00
Martin Panter 1f0e1f3cbb Issue #26261: Clarify NamedTemporaryFile name attribute vs file.name 2016-02-22 10:10:00 +00:00
Martin Panter 1c5e715d8f Fix errors in XML-RPC client example code
* http.client.HTTP (does not exist in Python 3) → HTTPConnection
* Server (deprecated) → ServerProxy
* Transport.send_request() grew a new “debug” parameter in Python 3 (revision
  a528f7f8f97a)
2016-02-22 09:04:22 +00:00
Berker Peksag 0334c3c735 Issue #26401: Fix compile() documentation
After 25032ec29315, compile() will raise a ValueError
if source contains null bytes.

Patch by SilentGhost.
2016-02-21 22:00:12 +02:00
Brett Cannon 27c712e149 List what classes from importlib.machinery don't work with importlib.util.LazyLoader 2016-02-20 18:40:02 -08:00
Martin Panter f817a48d17 Issues #22468, #21996, #22208: Clarify gettarinfo() and TarInfo usage
* The Windows-specific binary notice was probably a Python 2 thing
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
  files may need special care
* The file name must be text; 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 92849d1721 Closes #20169: fix inner links random doc. 2016-02-19 08:57:38 +01:00
Martin Panter eac17b8955 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
* Remove version 2.6 not relevant for Python 3 documentation
2016-02-19 03:27:46 +00:00
Berker Peksag 3fe64d0c5c Issue #16915: Clarify that mode parameter of socket.makefile() does not accept
the same values as open().
2016-02-18 17:34:00 +02:00
Ned Deily f38c93fb7f Issue #26368: fix typo in asynchio stream doc, reported by Ryan Stuart. 2016-02-16 13:27:04 +11:00
Guido van Rossum e93b06a0a3 Hopefully clarify the difference between Optional[t] and an optional argument. 2016-02-10 09:48:58 -08: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
Martin Panter 96a4f07107 Issues #26310, #26311: Fix typos in the documentation and code comments 2016-02-10 01:17:51 +00:00
Gregory P. Smith e27403b75f Clarify "cardinality of" as "number of elements in" as many readers do
not have a math vocabulary.
2016-02-08 09:58:40 -08:00