Commit Graph

357 Commits

Author SHA1 Message Date
Terry Jan Reedy 43cba219d5 Make expression legal python by adding '1'. 2015-05-23 16:16:28 -04:00
Raymond Hettinger 29655df11d Issue #24064: Docuement that oroperty docstrings are now writeable. 2015-05-15 16:17:05 -07:00
Raymond Hettinger 0907a45eb1 Issue #23695: Explain the zip() example for clustering a data series into n-length groups. 2015-05-13 02:34:38 -07:00
Steve Dower cb39d1f466 Issue 19933: Provide default argument for ndigits in round. Patch by Vajrasky Kok. 2015-04-15 16:10:59 -04:00
Victor Stinner 708d9ba5a2 Issue #23618: Document EINTR changes in socket documentation 2015-04-02 11:49:42 +02:00
Victor Stinner a766ddfa2f Issue #23648: Document the PEP 475 in the "Porting to Python 3.5" section and
add a version changed note in modified functions.
2015-03-26 23:50:57 +01:00
Benjamin Peterson b365a06a84 change Σ to ν for obscure joke reasons
https://twitter.com/ncoghlan_dev/status/579173053793353728
2015-03-24 12:12:44 -04:00
Serhiy Storchaka 07985ef387 Issue #22286: The "backslashreplace" error handlers now works with
decoding and translating.
2015-01-25 22:56:57 +02:00
Georg Brandl 3be472b5f7 Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Nick Coghlan 582acb75e9 Merge issue 19548 changes from 3.4 2015-01-07 00:37:01 +10:00
Nick Coghlan b9fdb7a452 Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Serhiy Storchaka 166ebc4e5d Issue #19676: Added the "namereplace" error handler. 2014-11-25 13:57:17 +02:00
Georg Brandl e21a531ef1 merge with 3.4 2014-10-31 10:39:29 +01:00
Georg Brandl e4196d3f2e #22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) 2014-10-31 09:41:46 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Ezio Melotti a7d19fe93b #22237: merge with 3.4. 2014-10-28 12:58:47 +01:00
Ezio Melotti 9b1e92f5a1 #22237: document that sorted() is guaranteed to be stable. Initial patch by Martin Panter. 2014-10-28 12:57:11 +01:00
Victor Stinner 7cf710af3b Merge 3.4 (open doc) 2014-10-22 09:57:30 +02:00
Victor Stinner c803bd84b5 Issue #22695: Fix syntax of open() doc 2014-10-22 09:55:44 +02:00
Robert Collins 933430ab69 Issue #17401: document closefd in io.FileIO docs and add to repr
closefd was documented in the open docs but not the matching FileIO
class documented. Further, closefd, part of the core state for the
object was not shown.

In review it was noted that the open docs are a little confusing about
the interaction between closefd and paths, so tweaked them at the same
time.
2014-10-18 13:32:43 +13:00
Georg Brandl c53bc48068 merge with 3.4 2014-10-06 13:54:43 +02:00
Georg Brandl eb7e8f607e Document builtin classes as such, not functions. 2014-10-06 13:54:36 +02:00
Terry Jan Reedy cf4d6997a3 Merge with 3.4 2014-10-01 15:39:05 -04:00
Terry Jan Reedy 1895f2b544 Issue 22492: Be explicit that print does not support binary mode files.
Original patch by Georg Brandl.
2014-10-01 15:37:42 -04:00
Benjamin Peterson 7809569a2e sigma actually works in latex... 2014-09-01 18:26:22 -04:00
Benjamin Peterson 7df46aaf32 try to pick a unicode char that latex understands 2014-09-01 18:04:02 -04:00
Benjamin Peterson 5fb161f170 a more universal unicode char example 2014-09-01 17:59:18 -04:00
Nick Coghlan eed671910f Clarify ord() and chr() documentation 2014-08-17 14:07:53 +10:00
Raymond Hettinger ac191ce1d3 Issue #22174: Clean-up grammar and ambiguities in property() docs. 2014-08-10 10:41:25 -07:00
Berker Peksag 3410af45f8 Add an index entry for exec() builtin.
Reported by Draic Kin on docs@.
2014-07-04 15:06:45 +03:00
Terry Jan Reedy f2fb73f675 Issue #19362: Tweek len() doc and docstring to expand the indicated range of
arguments. Original patch by Gareth Rees.
2014-06-16 03:05:37 -04:00
Serhiy Storchaka d3faf43f9b Issue #23181: More "codepoint" -> "code point". 2015-01-18 11:28:37 +02:00
Raymond Hettinger b30b34c1aa Issue 21143: Fix typo in docs for max(). 2014-04-03 08:01:22 -07:00
Raymond Hettinger f4284e45d0 Documentation nit. List the traditional keyword-only argument first and the default last. 2014-04-02 00:58:47 -07:00
Georg Brandl df48b97855 Fix a few scoping issues with versionadded/versionchanged directives. 2014-03-24 09:06:18 +01:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Benjamin Peterson d45a46b60d merge 3.3 (#19910) 2013-12-06 20:12:51 -05:00
Benjamin Peterson 933142a8f2 document that compile() can take bytes (closes #19910) 2013-12-06 20:12:39 -05:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Serhiy Storchaka 6787a3806e Issue #15204: Deprecated the 'U' mode in file-like objects. 2013-11-23 22:12:06 +02:00
Serhiy Storchaka 0d85b5c68d Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:03:24 +03:00
Serhiy Storchaka 0d196edc37 Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:31 +03:00
Victor Stinner daf455554b Issue #18571: Implementation of the PEP 446: file descriptors and file handles
are now created non-inheritable; add functions os.get/set_inheritable(),
os.get/set_handle_inheritable() and socket.socket.get/set_inheritable().
2013-08-28 00:53:59 +02:00
Brett Cannon f9f0458961 merge emphasized discouragement of overriding __import__ 2013-08-23 11:00:04 -04:00
Brett Cannon f5ebd26403 Emphasize that people should not override __import__.
With importlib getting used more and more, changing __import__ will
not work as well as people used to hope as it will potentially bypass
importers, etc. It also will not work with importlib.import_module()
as it uses "importlib.__import__" (i.e. importlib's implementation of
import) directly and not builtins.__import__.
2013-08-23 10:58:49 -04:00
Barry Warsaw 4958f714bd - Issue #18440: Clarify that `hash()` can truncate the value returned from an
object's custom `__hash__()` method.
2013-07-15 15:21:41 -04:00
Barry Warsaw 224a599c0c - Issue #18440: Clarify that `hash()` can truncate the value returned from an
object's custom `__hash__()` method.
2013-07-15 14:47:29 -04:00
Raymond Hettinger 4d6018fe45 Issue 18111: Add a default argument to min() and max() 2013-06-24 22:43:02 -07:00
Andrew Kuchling f567727abc Merge with 3.3 2013-06-16 13:02:55 -04:00
Andrew Kuchling c7b6c50f29 Describe 'surrogateescape' in the documentation.
Also, improve some docstring descriptions of the 'errors' parameter.

Closes #14015.
2013-06-16 12:58:48 -04:00
Raymond Hettinger d71001749d Clarify which dictionaries are updateable
by using the wording from the Py2.7 docs.
2013-06-02 10:03:05 -07:00
Raymond Hettinger 697fd46d15 merge 2013-06-02 10:04:59 -07:00
Georg Brandl 1bab7134a8 Merge with 3.3. 2013-03-28 13:28:55 +01:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Terry Jan Reedy 8b8df5a8fb Merge with 3.3 2013-03-16 15:57:27 -04:00
Terry Jan Reedy f39cab1076 Merge with 3.2 2013-03-16 15:56:50 -04:00
Terry Jan Reedy dff04f44bc Issue #17418: specify that buffer sizes are bytes as soon as possible. 2013-03-16 15:56:27 -04:00
Ezio Melotti a41fb4be5b #17351: merge with 3.3. 2013-03-11 09:43:25 +02:00
Ezio Melotti c9cfcf1e6c #17351: merge with 3.2. 2013-03-11 09:42:40 +02:00
Ezio Melotti af8838f443 #17351: remove "object" inheritance from docs. Patch by Phil Elson. 2013-03-11 09:30:21 +02:00
Mark Dickinson 07c7136524 Issue #16772: in int(x, base), non-integer bases must have an __index__ method. 2013-01-27 10:17:52 +00:00
Andrew Svetlov 0794fe0356 Add NEWS and docs for #9856 2012-12-23 15:12:19 +02:00
Chris Jerdonek bb4e941c6d Add a str class entry to the "Text Sequence Type" section (issue #16209).
This commit also moves the documentation for the str built-in function to
the new class entry.  Links to :class:`str` now go to the class entry with
the string methods immediately afterwards.
2012-11-28 01:38:40 -08:00
Éric Araujo 5bd9270954 Address reviews for open’s opener argument doc patch (#13424).
* Remove example deemed not helpful.
* Simplify the other one.
* Add missing target to ref.
2012-11-22 00:13:49 -05:00
Chris Jerdonek 5fae0e5854 Improve str() and object.__str__() documentation (issue #13538). 2012-11-20 17:45:51 -08:00
Chris Jerdonek 296c2fd065 Merge from 3.2: adjust set and frozenset function docs (issue #16436). 2012-11-09 18:58:06 -08:00
Chris Jerdonek df3abec2c9 Link set and frozenset function docs to their class definitions (issue #16436). 2012-11-09 18:57:32 -08:00
Éric Araujo 309b043237 Avoid fd leak in example. Caught by Serhiy. 2012-11-03 17:39:45 -04:00
Éric Araujo 8f423c9359 Add examples for opener argument of open (#13424).
Patch by Guillaume Pratte.
2012-11-03 17:06:52 -04:00
Ezio Melotti e6c0f0d94a #16210: merge with 3.2. 2012-10-24 23:06:56 +03:00
Ezio Melotti 837cd06d36 #16210: combine the two type() docs. Patch by Pete Sevander. 2012-10-24 23:06:25 +03:00
Chris Jerdonek 39b867000b Issue #16206: Merge dict documentation improvements from 3.2.
Improve the documentation of the dict constructor.  This change includes
replacing the single-line signature documentation with a more complete
multiple-line signature.
2012-10-13 03:25:18 -07:00
Chris Jerdonek f341317185 Issue #16206: Improve the documentation of the dict constructor.
This change includes replacing the single-line signature documentation
with a more complete multiple-line signature.
2012-10-13 03:22:33 -07:00
Chris Jerdonek 006d907afc Undo changes accidentally reverted in de8787029fe4. 2012-10-12 20:28:26 -07:00
Benjamin Peterson 143d034ecd merge 3.2 2012-10-12 12:04:32 -04:00
Ezio Melotti 7fa822275b Fix links to the __next__ method. 2012-10-12 13:42:08 +03:00
Chris Jerdonek 042fa653ab Issue #14783: Merge changes from 3.2. 2012-10-07 14:56:27 -07:00
Chris Jerdonek 83fe2e1c22 Issue #14783: Improve int() docstring and also str(), range(), and slice().
This commit rewrites the docstring for int() to incorporate the documentation
changes made in issue #16036.  It also switches the docstrings for int(),
str(), range(), and slice() to use multi-line signatures.
2012-10-07 14:48:36 -07:00
Chris Jerdonek 2246aa8ac8 Issue #16036: Merge update from 3.2. 2012-09-28 01:15:39 -07:00
Chris Jerdonek 57491e0703 Issue #16036: Improve documentation of built-in int()'s signature and arguments. 2012-09-28 00:10:44 -07:00
Mark Dickinson 7c6c80d89f Issue 15985: merge from 3.2. 2012-09-20 20:51:53 +01:00
Mark Dickinson 4e12ad19c9 Issue 15985: fix round argument names in documentation. Thanks Chris Jerdonek. 2012-09-20 20:51:14 +01:00
Ezio Melotti 8429b6784b #15831: merge with 3.2 2012-09-14 06:35:09 +03:00
Ezio Melotti e0add76468 #15831: document multiple signatures on different lines. Patch by Chris Jerdonek. 2012-09-14 06:32:35 +03:00
Nick Coghlan 83c0ae5de6 Address most of Ezio's comments. str/bytes/bytearray docs still need consolidation 2012-08-21 17:42:52 +10:00
R David Murray ed7fb9c74d Merge #15694: reflow paragraph. 2012-08-17 20:40:03 -04:00
R David Murray 433ef3b5c3 #15694: reflow paragraph. 2012-08-17 20:39:21 -04:00
R David Murray 8eac575e81 Merge #15694: Link discussion of file objects to glossary entry.
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.

Patch by Chris Jerdonek.
2012-08-17 20:38:19 -04:00
R David Murray 9f0c9401d3 #15694: Link discussion of file objects to glossary entry.
This is analogous to the link for `flie objects` in the description of
'open' that exists in the 2.7 docs, and adds a similar link to the
io docs.

Patch by Chris Jerdonek.
2012-08-17 20:33:54 -04:00
R David Murray 27bbcfb8ff Merge #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 11:11:27 -04:00
R David Murray ee0a945ae4 #15543: reflow paragraphs. 2012-08-15 11:05:36 -04:00
R David Murray 1b00f25bf9 #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 10:43:58 -04:00
Georg Brandl 1487c931cb merge with 3.2 2012-08-14 09:40:26 +02:00
Georg Brandl 296d1bea6a Restore original line lengths. 2012-08-14 09:39:07 +02:00
Andrew Svetlov e4b1a189a7 Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
2012-08-13 12:59:00 +03:00
Andrew Svetlov ecd78feb78 Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
2012-08-13 12:58:02 +03:00
Andrew Svetlov 439e17fb0b update doctests 2012-08-12 15:16:42 +03:00
Brett Cannon cb4996afe4 Issue #15471: Don't use mutable object as default values for the
parameters of importlib.__import__().
2012-08-06 16:34:44 -04:00