Commit Graph

7482 Commits

Author SHA1 Message Date
Tommy Beadle 63b91e5403 Issue #24617: Add comment for os.mkdir about mode quirks 2016-06-02 15:41:20 -04:00
Martin Panter 553245c6f5 Issue #8491: Add link to Gnu Readline configuration documentation 2016-06-10 00:27:46 +00:00
Tommy Beadle e9b8403a1f [Issue 15476] Make "code object" its own entry in the index 2016-06-02 19:26:51 -04:00
Yury Selivanov c1cf296de6 asyncio: Remove asyncio.timeout() context manager.
It will probably be added back in Python 3.6, once its compatibility
issues are resolved; see [1] for more details.

[1] https://mail.python.org/pipermail/async-sig/2016-June/000045.html
2016-06-08 13:57:03 -04:00
Yury Selivanov 55c5084223 Issue #27136: Update asyncio docs 2016-06-08 12:48:15 -04:00
Berker Peksag 84f387d420 Issue #21593: Clarify that re.search() returns the first match 2016-06-08 14:56:56 +03:00
Martin Panter e42e129ebe Issue #25738: Don’t send message body for 205 Reset Content
Patch by Susumu Koshiba.
2016-06-08 08:29:13 +00:00
Victor Stinner dddf4849ec os.urandom() doesn't block on Linux anymore
Issue #26839: On Linux, os.urandom() now calls getrandom() with GRND_NONBLOCK
to fall back on reading /dev/urandom if the urandom entropy pool is not
initialized yet. Patch written by Colm Buckley.
2016-06-07 11:21:42 +02:00
Ned Deily 8f5798edfb Issue #26014: Update 3.x packaging documentation:
- "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:38:48 -07:00
Martin Panter ed0425c60a Issue #24291: Avoid WSGIRequestHandler doing partial writes
If the underlying send() method indicates a partial write, such as when the
call is interrupted to handle a signal, the server would silently drop the
remaining data.

Also add deprecated support for SimpleHandler.stdout.write() doing partial
writes.
2016-06-05 06:28:55 +00:00
Kushal Das 89beb27061 Issue #19234: Documents socket.fileno() returns -1 on failure 2016-06-04 10:20:12 -07:00
Ned Deily 32db43867c Issue 27216: Fix typo (noticed by Alex Chan). 2016-06-04 09:40:40 -07:00
Martin Panter 3ee6270262 Fix typos in code comment and documentation 2016-06-04 04:57:19 +00:00
R David Murray 21dcb932a7 #22797: clarify when URLErrors are raised by urlopen. 2016-06-03 13:29:17 -04:00
Senthil Kumaran 7ee91942b4 issue27113 - Document "check_same_thread" parameter in sqlite3.connect api.
Patch contributed by Dave Sawyer.
2016-06-03 00:03:48 -07:00
Senthil Kumaran 0779129302 issue8519 - Reference termios and ioctl manual pages in the library documentation. 2016-06-02 23:49:05 -07:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) 583a1d6240 Document that CalledProcessError.returncode is the negative
signal number when the process died due to a signal.
2016-06-03 00:31:21 +00:00
R David Murray dd4fcf52f4 #26829: Clarify that namespace is copied to a new __dict__ in instance creation.
Patch by Emily Morehouse.
2016-06-02 20:05:43 -04:00
Berker Peksag 8891dfe717 Issue #16192: Fix copy and paste mistake noticed by Eryk Sun 2016-06-02 15:28:00 -07:00
R David Murray f86959d883 #13784: fix xml.sax.reader getColumn/LineNumber docs.
verification and patch by Emily Morehouse.
2016-06-02 15:14:30 -04:00
Berker Peksag d85a1e6b55 Issue #16192: Clarify when c_int is an alias to c_long in ctypes documentation 2016-06-02 12:17:51 -07:00
Berker Peksag 1b207c55a4 Issue #12243: Remove redundant availability notes from getpass docs
Patch by Bryce Verdier.
2016-06-01 18:26:18 -07:00
Martin Panter 7aaaded8f4 Issue #25570: Add example of customizing User-Agent via add_header() 2016-06-01 08:10:50 +00:00
Zachary Ware f9aff925e0 Fix typo 2016-06-01 00:01:10 -05:00
Martin Panter a90a4a9651 Issue #27125: Remove duplicated words from documentation and comments 2016-05-30 04:04:50 +00:00
Senthil Kumaran ebd84e342c issue27043 - Explain the inspect.cleandoc behavior on synopsis line and other lines.
Patch contributed by Nathan Harold.
2016-05-29 20:36:58 -07:00
Martin Panter 8d56c026a5 Issue #27125: Fix various errors like “will [be] inherited” 2016-05-29 04:13:35 +00:00
Martin Panter 58dd7648de Issue #27124: Fix documentation of exception raised by a2b_hex() 2016-05-29 00:48:54 +00:00
Eric Snow 338502b307 Issue #27147: Mention PEP 420 in the importlib docs. 2016-05-28 11:56:53 -06:00
Raymond Hettinger 819581b843 Issue 25926: Clarify that the pure python equivalents are only approximate. 2016-05-28 00:10:56 -07:00
Martin Panter fe289c0f6f Issue #26553: Capitalization of HTTP, HTTPS, FTP, and URL
Patch by Anish Shah and Aatish Neupane.
2016-05-28 02:20:39 +00:00
Martin Panter 6bb91f3b6e Issue #20699: Document that “io” methods accept bytes-like objects
This matches the usage of ZipFile and BufferedWriter. This still requires
return values to be bytes() objects.

Also document and test that the write() methods should only access their
argument before they return.
2016-05-28 00:41:57 +00:00
Martin Panter c618ae8ed7 Issue #5784: wbits=0 apparently added in zlib v1.2.3.5 2016-05-27 11:20:21 +00:00
Martin Panter 0fdf41d847 Issue #5784: Expand documentation and tests for zlib wbits parameter
Based on documentation by AM Kuchling.
2016-05-27 07:32:11 +00:00
Berker Peksag 732ba821ca Issue #27075: Link to StreamReader and StreamWriter docs
Patch by Ville Skyttä.
2016-05-21 14:56:35 +03:00
Guido van Rossum 387e6e3817 Back out pathlib.Path.path attr. (Merge 3.4->3.5) 2016-05-19 13:10:20 -07:00
Guido van Rossum 3d4d01f614 Back out 7e9605697dfc, 2e3c31ab586a, 759b2cecc289.
These added a path attribute to pathlib.Path objects, and docs.
Instead, we're going to use PEP 519.

(Starting in the 3.4 branch and merging forward from there since that's what I did originally.)
2016-05-19 13:00:21 -07:00
Serhiy Storchaka e5ea1abf91 Issue #27036: Fixed formatting references to "bytes-like object" in plural. 2016-05-18 13:54:54 +03:00
Yury Selivanov 950204df9c docs: Update asyncio docs & whatsnew 2016-05-16 16:23:00 -04:00
Martin Panter f47a400347 Issue #25533: Update documentation regarding the frozen modules table
* "ctypes" documentation was using Python 2 bytes-str equivalence.
* PyImport_FrozenModules is a pointer to const as of Python 3.4
2016-05-15 00:13:04 +00:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Martin Panter 4c35964b76 Corrections for a/an in code comments and documentation 2016-05-08 13:53:41 +00:00
Martin Panter 129fe04d4d Issue #26512: Clarify Integral; tidy up table of rounding functions
Based on patch by Julien.
2016-05-08 12:22:37 +00:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Serhiy Storchaka 64099ea58e Issue #26889: Fixed hyperlinks formatting. 2016-05-07 10:05:02 +03:00
Serhiy Storchaka da7880ad95 Issue #26889: Tweaked xmlrpc.client documentation. 2016-05-07 08:44:15 +03:00
Berker Peksag bace976db1 Issue #26957: Remove duplicate 'the' from datetime documentation
Patch by Alex Chan.
2016-05-04 23:25:44 +03:00
Terry Jan Reedy 929d7f86d5 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:30:02 -04:00
Berker Peksag 5d6fd8c936 Issue #26322: Document typing.Set, patch by Joseph Moran 2016-04-29 14:41:16 +03:00
Zachary Ware 42f740d854 Issue #26875: Fix mmap example
Patch by Xiang Zhang.
2016-04-28 14:47:12 -05:00
Serhiy Storchaka a87e6ba0ac fileinput.hook_encoded() uses builtin open(), not codecs.open(). 2016-04-27 23:06:15 +03:00
Martin Panter f5e60480b9 Issue #20598: Replace trivial split() calls with lists in argparse docs 2016-04-26 11:41:25 +00:00
Senthil Kumaran a7c0ff2f0b Issue #26804: urllib.request will prefer lower_case proxy environment variables
over UPPER_CASE or Mixed_Case ones.

Patch contributed by Hans-Peter Jansen. Reviewed by Martin Panter and Senthil Kumaran.
2016-04-25 08:16:23 -07:00
Zachary Ware d3304e3e20 FileExistsError is raised by mkdir when dir exists
Reported by Saul Spatz on docs@
2016-04-25 09:27:27 -05:00
Berker Peksag 8724a2adf2 Issue #23662: Document default value of RFC 2109 attributes 2016-04-25 14:32:19 +03:00
Martin Panter e37fc18b3c Issue #24911: All socket objects are context managers; update examples 2016-04-24 04:24:36 +00:00
Berker Peksag 77e543c6cd Issue #21382: Clarify signal.signal() documentation on Windows
All signal.SIG* constants may not be defined on Windows so a call like

    signal.signal(signal.SIGPIPE, lambda signum, frame: sys.exit(1))

will raise an AttributeError.
2016-04-24 02:59:16 +03:00
Berker Peksag 0269828320 Issue #20112: Improve BaseHTTPRequestHandler.error_message_format documentation
* Explain how 'error_message_format' is used by 'send_error' method
* Mention that 'responses' is used by 'send_response_only' and 'send_error' methods
* Replace 'class variables' with 'attributes'

Initial patch by Anastasia Filatova.
2016-04-24 01:51:02 +03:00
Serhiy Storchaka 585c93daea Issue #26733: Disassembling a class now disassembles class and static methods.
Patch by Xiang Zhang.
2016-04-23 09:23:52 +03:00
Senthil Kumaran 21ce717eaf Issue23806 - Document the no_proxy environment variable in Python 3 docs. 2016-04-22 20:34:42 -07:00
Martin Panter 8f26565ba9 Fix spelling (inital), grammar (may translates) in documentation, comments 2016-04-19 04:03:41 +00:00
Paul Moore b5d164cc3f Mention types.SimpleNamespace in collections.namedtuple doc
Issue #26805.
2016-04-19 19:17:16 +01:00
Jesus Cea ded4c4967b Trivial typo 2016-04-19 21:50:19 +02:00
Berker Peksag 472233ec83 Issue #26615: Add missing __qualname__ entry to functools.update_wrapper() docs
Patch by Xiang Zhang.
2016-04-18 21:20:50 +03:00
Serhiy Storchaka 6a7b3a77b4 Issue #26778: Fixed "a/an/and" typos in code comment and documentation. 2016-04-17 08:32:47 +03:00
Martin Panter 119e502277 Fix typos in code comments and documentation 2016-04-16 09:28:57 +00:00
Martin Panter 00ccacc8db Issue #26638: Fix links to some CLI options and section headings
* Disable inappropriate links to Python interpreter options
* Correct link to CLI section in zipapp
* Make CLI section label in timeit less ambiguous
2016-04-16 04:59:38 +00:00
Martin Panter b4912b8ed3 Issue #25314: Remove confused statement about const argument 2016-04-09 03:49:48 +00:00
Martin Panter b030991a5f Issue #26535: Correct docs regarding the struct buffer size 2016-04-15 23:03:54 +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
Martin Panter 7f7c605f29 Issue #25496: Document compresslevel defaults to 9, by Hamza T Khan 2016-04-13 03:24:06 +00:00
Georg Brandl 7ff033bd62 Clarify greedy-qualifier example, avoid HTML. 2016-04-12 07:51:41 +02:00
Victor Stinner a9901e86ba typing doc: add versionadded 3.5 2016-04-11 16:23:22 +02:00
Berker Peksag 2c57da0e48 Add a versionchanged directive to document addition of the new 'namereplace' error handler.
Reported by Robert on docs@p.o.
2016-04-11 13:49:46 +03:00
Berker Peksag 8fafc74d45 Fix typos in mock and exceptions docs
The default value of __len__ is 0, not 1:

    >>> from unittest.mock import MagicMock
    >>> mock = MagicMock()
    >>> len(mock)
    0

Reported by Alex on docs@p.o.

Remove the remaining VMSError reference. VMS support is gone.
2016-04-11 12:23:04 +03:00
Martin Panter 199e3f8b96 Issue #14456: Remove contradiction about blocking signals from bad merge 2016-04-11 02:44:34 +00:00
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
Andrew Svetlov f1240169b3 Document asyncio.timeout() 2016-01-11 14:40:35 +02:00
Benjamin Peterson 6829dbbf3f delete old crypto prose (closes #26066) 2016-01-09 23:55:47 -08:00
Benjamin Peterson 8a6ddb98e6 fix typo in unittest docs (closes #26046)
Patch from Upendra Kumar.
2016-01-07 22:01:26 -08:00
Senthil Kumaran f3695bfacf Issue16544 - Add a link to an external documentation resource in ast module docs. 2016-01-06 21:26:53 -08:00
Guido van Rossum b1360543e5 Add versionadded (3.4.5) to docs for issue #22570. 2016-01-06 11:23:31 -08:00
Guido van Rossum df85946e8a Docs for issue #22570. 2016-01-06 11:15:52 -08:00
Senthil Kumaran 114a1d638e Issue24898 - Improve str.find documentation.
Simplify str.find explaination as per Georg Brandl's suggestion.
2016-01-03 17:57:10 -08:00
Senthil Kumaran a880800363 Issue21221 - Explain the usage of tm_isdst attribute of mktime, with valid
values and meaning.

Patch contributed by Andrew Scheller.
2016-01-03 00:40:03 -08:00
Senthil Kumaran d03d1d45f5 Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki. 2016-01-01 23:25:58 -08:00
Yury Selivanov cba0053bef docs/asyncio: Twek sections names per Nick Coghlan suggestion 2015-12-16 21:30:52 -05:00
R David Murray 2b4f47ee35 #25495: Clarify b2a_base64 documentation vis 57 bytes. 2015-12-13 18:04:27 -05:00
Zachary Ware 992bfe093e Issue #25767: Link to English Wikipedia instead of French. 2015-11-30 22:56:17 -06:00
Martin Panter 747d48cf27 Issues #22989, #21228: Document HTTP response object for urlopen()
Previous documentation was not clear if the geturl(), info() and getcode()
were valid for HTTP responses. The “msg” attribute is different to the usual
HTTPResponse.msg attribute. Based on patch by Evens Fortuné.
2015-11-26 11:01:58 +00:00
Vinay Sajip 4f44d53770 Issue #25508: Clarify documentation on LogRecord args attribute. 2015-11-24 23:21:15 +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
Serhiy Storchaka bf7b9ede1a Issue #25706: Fixed markup in the documentation. 2015-11-23 16:43:05 +02:00
Martin Panter 828123ce4e Issue #25689: Fix language in ftplib and nntplib docs
Original patch by Silent Ghost.
2015-11-21 22:03:08 +00:00
Guido van Rossum 41f69f4cc7 Issue #25593: Change semantics of EventLoop.stop(). 2015-11-19 13:28:47 -08:00
Yury Selivanov 01a65af4a1 asyncio.docs: Fix versionadded 2015-11-18 12:44:31 -05:00
Martin Panter 38fe4dc400 Issue #23200: Document that max_length=0 is not supported 2015-11-18 00:59:17 +00:00
Martin Panter f8f66eb985 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 9f3c094e68 Issue #25615: Document unsorted behaviour of glob; patch by Dave Jones 2015-11-16 23:46:22 +00:00
Yury Selivanov 1744d53930 asyncio.docs: Document Transport.is_closing 2015-11-16 12:46:41 -05:00
Martin Panter 2e4571a456 Fix a few grammar problems in the documentation and comments 2015-11-14 01:07:43 +00:00
Martin Panter ac34e09bbf Correct Content-Type syntax in documentation 2015-11-14 00:58:32 +00:00
Victor Stinner 9cccfcecc8 Issue #25605: Document exceptions raised by fcntl.ioctl() and fcntl.flock() 2015-11-13 09:13:48 +01:00
Zachary Ware 71a0b43854 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
Guido van Rossum 8778c6b77e Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch by Akira Li. 2015-11-02 09:15:47 -08:00
Serhiy Storchaka d65c9496da Issue #25523: Further a-to-an corrections. 2015-11-02 14:10:23 +02:00
Martin Panter 7462b64911 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
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Martin Panter 1f1177d69a Fix some spelling errors in documentation and code comments 2015-10-31 11:48:53 +00:00
Terry Jan Reedy 3e8a7ad7fc Issue #25519: Mark difflib.ndiff as a functions where not already. 2015-10-30 19:41:16 -04:00
Terry Jan Reedy 68b6874f59 Issue #25432: Explain isinstance behaviour when type is a tuple. 2015-10-28 03:14:56 -04:00
Martin Panter 5487c13e44 Issue #23391: Restore OSError constructor argument documentation
This restores details lost in revision 097f4fda61a4 (since Python 3.3,
related to the new OSError subclasses). Further additions:

* Markup for attributes and constructor signature
* Explain "winerror" and "filename2"
* Extend test to check for filename2 defaulting to None
* Clarify that the constructor can return a subclass

I have intentionally left out any details of allowing more than five
arguments, or how the "args" attribute is set for four or more arguments.
These details seem to be dependent on the Python version and platform.
2015-10-26 11:05:42 +00:00
Victor Stinner 0e316f688e Issue #25461: Rephrase os.walk() doc
Patch written by Bernt Røskar Brenna.
2015-10-23 12:38:11 +02:00
Guido van Rossum 19ff6977a7 Issue #24885: Update note in docs about stream convenience functions. 2015-10-19 13:18:04 -07:00
Terry Jan Reedy 93f3542ae4 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:51 -04:00
Martin Panter d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Martin Panter cfad54344f Issue #22413: Document newline effect on StringIO initializer and getvalue
Also add to comment in the C code.
2015-10-10 03:01:20 +00:00
Berker Peksag 24a610984d Issue #16802: Document fileno parameter of socket.socket()
Patch by Henrik Heimbuerger and Bar Harel.
2015-10-08 06:34:01 +03:00
Martin Panter 9955a373a8 Various minor typos in documentation and comments 2015-10-07 10:26:23 +00:00
Martin Panter 85b8f45515 Issue #25286: Dictionary views are not sequences
Also change glossary heading from view
2015-10-07 09:56:46 +00:00
Guido van Rossum 601953b679 Docs and one small improvement for issue #25304, by Vincent Michel. 2015-10-05 16:20:00 -07:00
Guido van Rossum b9bf913ab3 Issue #23972: updates to asyncio datagram API. By Chris Laws. 2015-10-05 09:15:28 -07:00
Martin Panter 3795d12a0d Issue #16701: Document += and *= for mutable sequences 2015-10-03 07:46:04 +00:00
Terry Jan Reedy d470527aec 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:59 -04:00
Andrew Svetlov 1c62b52c3f Reflect parameter name change in the doc 2015-10-01 09:48:08 +03:00
Terry Jan Reedy 37f81355b0 Issue #24028: Add subsection about Idle calltips. 2015-09-29 01:55:57 -04:00
R David Murray 87d0066f1a Fix English phrasing. 2015-09-27 12:36:19 -04:00
Benjamin Peterson 1dd72e6bc5 make wikipedia link https 2015-09-27 02:05:01 -07:00
Benjamin Peterson c402d8dcea shorten and fix casing of title 2015-09-27 01:23:10 -07:00
Terry Jan Reedy f660ce2363 Issue #25225: Condense and rewrite Idle doc section on text colors. 2015-09-24 23:13:49 -04:00
Andrew Svetlov 4919907774 Fix #25208: Improve "Develop with asyncio" doc page.
Patch by Benjamin Hodgson.
2015-09-24 14:32:39 +03:00
Terry Jan Reedy 0053c47785 Issue 21995: Explain some differences between IDLE and console Python. 2015-09-24 03:09:43 -04:00
Victor Stinner bfd9767e0f Issue #24894: Document the codec iso8859_11
Patch written by Prashant Tyagi.
2015-09-24 09:04:05 +02:00
Terry Jan Reedy 8b5a981e02 Issue #22820: Explain need for *print* when running file from Idle editor. 2015-09-24 01:39:30 -04:00
Terry Jan Reedy 6e10ec5367 Issue 25224: Augment Idle doc feature list and no-subprocess section
to finish making current README.txt obsolete.
2015-09-23 20:00:33 -04:00
Terry Jan Reedy 968e285a8c Issue #25219: Update doc for Idle command line options.
Some were missing and notes were not correct.
2015-09-23 03:52:23 -04:00
Victor Stinner 5e4a7d8dc7 Issue #23630, asyncio: host parameter of loop.create_server() can now be a
sequence of strings. Patch written by Yann Sionneau.
2015-09-21 18:33:43 +02:00
Victor Stinner f7dc7fb74d Issue #25114, asyncio: add ssl_object extra info to SSL transports
This info is required on Python 3.5 and newer to get specific information on
the SSL object, like getting the binary peer certificate (instead of getting
it as text).
2015-09-21 18:06:17 +02:00
Berker Peksag 407c497e83 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 06:50:55 +03:00
Berker Peksag 44e4b11dd8 Issue #25169: os.getppid() is available on Windows since Python 3.2.
Patch by Bar Harel.
2015-09-21 06:12:50 +03:00
Martin Panter cebfdac32c Issue #25176: Correct link for cgi.parse_qsl; patch from Ville Skyttä 2015-09-20 00:28:50 +00:00
Ethan Furman 2a5f9da56c Issue24756: clarify usage of run_docstring_examples() 2015-09-17 22:20:41 -07:00
Berker Peksag 0b0c3b6624 Issue #25127: Fix typo in concurrent.futures.rst
Reported by Jakub Wilk.
2015-09-15 19:59:03 +03:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
Martin Panter 06171bd52a 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
Martin Panter f9b6875259 Issue #25063: socket.sendfile() does not exist in 3.4
Remove notice that was backported in revision 50527a1b769c.
2015-09-11 23:39:34 +00:00
Martin Panter ea7266d7c6 Issue #25043: Document BDADDR_ and HCI_ Bluetooth socket constants
Patch from Tim Tisdall.
2015-09-11 23:14:57 +00:00
Zachary Ware 79e5088a60 Fix grammatical error in csv docs.
Reported by Nat Dunn on docs@
2015-09-11 10:51:47 -05:00
Martin Panter db4220ea09 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 d8302624c9 Issue #24984: BTPROTO_SCO supports only bytes objects 2015-09-11 02:23:41 +00:00
Berker Peksag 920f6db10b Use print function in mock docs. 2015-09-10 21:41:15 +03:00
Martin Panter d1a98587fe Issue #24984: Document AF_BLUETOOTH socket address formats
Patch from Tim Tisdall.
2015-09-09 06:47:58 +00:00
Martin Panter 9499413508 os.sendfile(headers=None, trailers=None) arguments are not actually accepted
Needs to be tested on a BSD.
2015-09-09 05:29:24 +00:00
Martin Panter bf19d16950 Issue #23738: Document and test actual keyword parameter names
Also fix signature because os.utime(..., ns=None) is not allowed.
2015-09-09 01:01:13 +00:00
Martin Panter 7f02d6d0d9 Issue #23406: Clarify documentation on multiplying a sequence
Patch from Matheus Vieira Portela.
2015-09-07 02:08:55 +00:00
R David Murray 17227a7334 #24998: fix cut and paste error in subprocess example. 2015-09-04 10:01:19 -04:00
Victor Stinner 5492d358e4 asyncio doc: fix subprocess sections 2015-09-02 15:39:01 +02:00
Martin Panter 31e7f50d4c Issue #24952: Clarify default argument of stack_size() in threading, _thread
Patch from Mattip.
2015-08-31 03:15:52 +00:00
Benjamin Peterson 0612ffe8c8 fix spelling that was a bit confused (closes #24963) 2015-08-30 14:42:38 -07:00
Raymond Hettinger 7a3602e7cf Issue #24931: Resolve __dict__ conflict in namedtuple subclasses. 2015-08-30 09:13:48 -07:00
Zachary Ware 5e580da0b6 Issue #24947: Fix grammar in asyncio doc
Patch by tagatac
2015-08-27 15:54:39 -05:00
R David Murray 87cbfb20fb #24926: Fix typo in example. 2015-08-24 12:55:03 -04:00
Robert Collins a2b0055396 Issue #22812: Fix unittest discovery examples.
Patch from Pam McA'Nulty.
2015-08-24 12:14:28 +12:00
Ned Deily eca0445733 Issue #24079: Improve description of the text and tail attributes for
ElementTree Element objects.  Initial patch by Martin Panter.
2015-08-17 22:11:17 -04:00
Antoine Pitrou 4ce4f974da Issue #16554: fix description for MAKE_CLOSURE. Initial patch by Daniel Urban. 2015-08-13 20:37:08 +02:00
Zachary Ware 79b98df023 Issue #21279: Flesh out str.translate docs
Initial patch by Kinga Farkas, Martin Panter, and John Posner.
2015-08-05 23:54:15 -05:00
Robert Collins 1ae28d2ff3 Issue #20769: Improve reload() docs. Patch by Dorian Pula. 2015-08-05 08:20:53 +12:00
Terry Jan Reedy 30f1f67248 Issue #13884: Idle: Remove tearoff lines from menus. Patch by Roger Serwy. 2015-07-30 16:44:22 -04:00
Berker Peksag 41ca828580 Issue #12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
It should StreamWriter for Codecs.encode() and StreamReader for Codec.decode().

Patch by Nick Weinhold.
2015-07-30 18:26:10 +03:00
Robert Collins 1ee9283254 Issue #23254: Document how to close the TCPServer listening socket.
Patch from Martin Panter.
2015-07-29 12:52:40 +12:00
Robert Collins f79dfe3f25 Add versionchanged information for mock_open. 2015-07-24 04:09:59 +12:00
Robert Collins ca647ef60a Issue #21750: Further fixup to be styled like other mock APIs. 2015-07-24 03:48:20 +12:00
Robert Collins e02f6c20ff Issue #22153: Improve unittest docs. Patch from Martin Panter and evilzero. 2015-07-23 06:37:26 +12:00
Zachary Ware e36402a830 Fix usage of the default role.
The changes to Doc/library/unittest.mock.rst are almost entirely a
selective backport of the 3.5 page.
2015-07-06 23:58:12 -05:00
Zachary Ware 5c676f67d1 Fix suspicious markup 2015-07-06 23:27:15 -05:00
Benjamin Peterson 7dcbf900ac 'not' is very important here 2015-07-06 11:28:07 -05:00
Benjamin Peterson b8fd26256e tighten warning 2015-07-06 09:40:43 -05:00
Ned Deily f1ce6deb41 Issue #24330: Update IDLE doc and help to note "Configure IDLE" difference
on OS X.  Original patch by André Freitas.
2015-07-04 15:05:07 -07:00
R David Murray a1005ed1aa #24584: replace dead link with pointer to archive.org. 2015-07-04 15:44:14 -04:00
Berker Peksag 89584c97e4 Issue #23684: Clarify the return value of the scheme attribute of ParseResult and SplitResult objects.
Patch by Martin Panter.
2015-06-25 23:38:48 +03:00
Yury Selivanov 1096f761b6 Issue #24509: Clarify Handle.cancel() and loop.call_* methods. 2015-06-25 13:49:52 -04:00
Yury Selivanov bb96134368 asyncio.docs: Use less confusing title 2015-06-25 11:54:34 -04: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
Raymond Hettinger 1c90670bc2 Issue #24453: Fix doubled word. 2015-06-14 16:08:06 -07:00
Terry Jan Reedy 6ac5cc15ce whitespace 2015-06-12 16:47:44 -04:00
Terry Jan Reedy fe63c9a298 Issue #24406: Add sentences on dict comparisons, similar to those for Sequence
and set comparisions.  Patch by Gareth Rees.
2015-06-12 16:38:57 -04:00
Barry Warsaw 17d5f47423 - Issue #24351: Clarify what is meant by "identifier" in the context of
string.Template instances.
2015-06-09 14:20:31 -04:00
Benjamin Peterson d9ede872cd that this is "for Python" is obvious 2015-06-05 21:03:08 -05:00
Berker Peksag 12b50ce4cb Issue #23659: Document **fmtparams in csv.register_dialect docstring.
Initial patch by Brandon Milam.
2015-06-05 15:17:51 +03:00
Berker Peksag 25587742f6 Issue #24148: Fix incorrect Stats.sort_stats() example.
"cum" is not a valid argument.

Patch by Brandon Milam.
2015-06-05 14:48:29 +03:00
Ned Deily 11cf4f6498 Issue #24357: use example.org instead 2015-06-01 21:19:30 -07:00
Ned Deily 834f029c74 Issue #24357: fix real typo 2015-06-01 19:37:40 -07:00