Commit Graph

18659 Commits

Author SHA1 Message Date
Benjamin Peterson 6d3ad2f64d "Numeric Python" -> "NumPy" 2016-05-26 22:51:32 -07:00
Martin Panter 46f50726a0 Issue #27076: Doc, comment and tests spelling fixes
Most fixes to Doc/ and Lib/ directories by Ville Skyttä.
2016-05-26 05:35:26 +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
Senthil Kumaran c9bfc13aa9 issue27045 - Use backslash in windows path to script file. 2016-05-17 20:50:43 -07:00
Ned Deily cec95813b2 Issue #27049: fix doc typo 2016-05-17 21:44:46 -04:00
Benjamin Peterson 54044d605f class definitions only get argument lists (closes #27042) 2016-05-16 23:20:22 -07:00
Benjamin Peterson bc7ee43a6d Backed out changeset 71ff2235bb4c (closes #27042) 2016-05-16 23:18:33 -07: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
Benjamin Peterson 387235085c improve PyFunction_New docs (closes #26986)
Patch from Xiang Zhang.
2016-05-09 23:43:53 -07:00
Serhiy Storchaka c7cc9850d4 Issue #26156: Make expressions grammar description more semantically correct. 2016-05-08 21:59:46 +03:00
Martin Panter 4c35964b76 Corrections for a/an in code comments and documentation 2016-05-08 13:53:41 +00:00
Martin Panter f0564164ba Fix typos in comments, documentation and test method names 2016-05-08 13:48:10 +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
Raymond Hettinger b9531bcdcc Issue #24715: Improve sort stability example 2016-04-26 01:11:10 -07: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
Martin Panter 887bc96e2e Issue #23806: Update susp-ignored.csv 2016-04-24 04:06:15 +00:00
Berker Peksag 8d8221f0d6 Issue #26041: Remove "will be removed in Python 3.7" from description messages
We will keep platform.dist() and platform.linux_distribution() to make porting
from Python 2 easier.

Patch by Kumaripaba Miyurusara Athukorala.
2016-04-24 03:32:24 +03:00
Berker Peksag 2ec1bee1b3 Issue #19731: Update copyright year in docs.p.o footer
See https://mail.python.org/pipermail/python-legal-sig/2013-November/000059.html
for details.

Patch by Antoine Pitrou.
2016-04-24 03:21:13 +03:00
Berker Peksag 4f35d79d65 Issue #18572: Remove redundant note about surrogates in string escape doc 2016-04-24 03:13:40 +03:00
Berker Peksag 544ae59b8e Issue #18353: Remove PyUnicode_WRITE_CHAR macro link from c-api/unicode.rst
Patch by Corey Brune.
2016-04-24 03:06:44 +03: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
Benjamin Peterson 95b5f0ad7e fix python 3 mod init function declaration (closes #26827) 2016-04-22 23:43:10 -07: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
Brett Cannon abf797df66 Issue #26760: Minimally document PyFrameObject 2016-04-15 12:43:50 -07:00
Martin Panter 20d325574e Issue #15984: Correct PyUnicode_FromObject() and _FromEncodedObject() docs 2016-04-15 00:56:21 +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
Serhiy Storchaka de886d9233 Issue #25910: Fixed more links in the docs. 2016-04-11 17:32:33 +03: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
Serhiy Storchaka a1f5f8bc79 Merge heads 2016-04-11 12:38:54 +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
Serhiy Storchaka 90be7333ea Issue #25910: Fixed dead links in the docs. 2016-04-11 12:18:56 +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
Berker Peksag 705c0e38c2 Issue #17264: Fix cross refs and a markup error in extending/building.rst 2016-04-09 09:08:05 +03: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
Vinay Sajip d93a60149c Added a cookbook recipe for a logging context manager. 2016-04-01 23:13:01 +01: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
Berker Peksag 25c0ef518d Issue #26246: Set initial value of the hidden attr when creating copy button.
Patch by Liang-Bo Wang.
2016-03-02 19:40:08 +02:00
Ezio Melotti 90ba2ca68a #26246: update copybutton.js after JQuery update. Patch by Liang-Bo Wang. 2016-02-27 08:39:36 +02:00
Benjamin Peterson c836f717cd remove script from epub (closes #26172) 2016-01-20 22:02:30 -08: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
Benjamin Peterson 630329e4ea merge 3.3 2016-01-01 11:55:47 -06:00
Benjamin Peterson 0e617e22f0 remove some copyright notices supserseded by the toplevel ones 2016-01-01 11:53:47 -06:00
Benjamin Peterson e8c2a957c8 merge 3.3 2016-01-01 10:24:21 -06:00
Benjamin Peterson 75e3630c60 2016 will be another year of writing copyrighted code 2016-01-01 10:23:45 -06: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
R David Murray 51d3f8b0ba #25679: spelling fix 2015-11-20 09:57:20 -05:00