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
Brett Cannon
222d473df4
Issue #15482 : Merge 78449:3fe01f7520e2 with a minor clarification.
2012-08-05 20:49:53 -04:00
Brett Cannon
9b000e7a68
Issue #15482 : Properly document the default 'level' parameter for
...
__import__().
To help explain why the -1 default value is typically not seen, a note
about how import statements only use values of >= 0 is also noted.
2012-08-05 20:46:25 -04:00
Victor Stinner
d1f9352bd4
(Merge 3.2) open() / TextIOWrapper doc: make it explicit than newline='\n'
...
doesn't translate newlines on output.
2012-08-04 01:22:07 +02:00
Victor Stinner
401e17d0f0
open() / TextIOWrapper doc: make it explicit than newline='\n' doesn't
...
translate newlines on output.
2012-08-04 01:18:56 +02:00
Brett Cannon
60622ed12a
Minor markup tweak.
2012-07-30 19:31:00 -04:00
Brett Cannon
73df364ee6
Add a versionchanged mention to __import__ in regards to negative level values.
2012-07-30 18:35:17 -04:00
Chris Jerdonek
17fc44c9b3
Improve str() and object.__str__() documentation (issue #13538 ).
2012-11-20 17:31:02 -08:00
Terry Jan Reedy
dd445e8ece
Merge 3.2 closes issue 13557
2012-07-08 17:52:58 -04:00
Terry Jan Reedy
83efd6cbb6
Issue #13557 : Clarify effect of giving two different namespaces to exec or
...
execfile().
2012-07-08 17:36:14 -04:00
Victor Stinner
f86a5e8a93
Close #11022 : TextIOWrapper doesn't call locale.setlocale() anymore
...
open() and io.TextIOWrapper are now calling locale.getpreferredencoding(False)
instead of locale.getpreferredencoding() in text mode if the encoding is not
specified. Don't change temporary the locale encoding using locale.setlocale(),
use the current locale encoding instead of the user preferred encoding.
Explain also in open() documentation that locale.getpreferredencoding(False) is
called if the encoding is not specified.
2012-06-05 13:43:22 +02:00
Charles-François Natali
b93f9fa700
Issue #12760 : Add some mising documentation about the new `x` exclusive
...
creation flag to open().
2012-05-20 11:41:53 +02:00
Nick Coghlan
7fc570a51e
Close #14588 : added a PEP 3115 compliant dynamic type creation mechanism
2012-05-20 02:34:13 +10:00
Brett Cannon
2a082add9d
Clarify that one should not use __import__() directly. Also mention
...
PEP 328 in explaining how 'index' works.
2012-04-14 21:58:33 -04:00
Mark Dickinson
c7ceb2bc95
merge 3.2 ( #9574 )
2012-03-10 16:11:49 +00:00
Mark Dickinson
328dd0d5f3
Closes #9574 : Note that complex constructor doesn't allow whitespace around central operator.
2012-03-10 16:09:35 +00:00
Terry Jan Reedy
a3d1e2e342
#11633 At least 2 people prefer earlier revision.
2012-01-12 14:49:02 -05:00
Terry Jan Reedy
e247928fed
Closes #11633 Clarify print buffering.
2012-01-11 14:09:49 -05:00
Georg Brandl
bc3b682923
Closes #13761 : add a "flush" keyword argument to print().
2012-01-13 19:41:25 +01:00
Terry Jan Reedy
dc41e3f23f
Merge #11633 At least 2 people prefer earlier revision.
2012-01-12 14:51:14 -05:00
Terry Jan Reedy
7a825ba3c6
Merge with 3.2
...
#11633 Clarify print buffering (will change again if 13761 adds flush param).
2012-01-11 14:14:14 -05:00
Benjamin Peterson
878ce389a0
add introspection to range objects ( closes #9896 )
...
Patch by Daniel Urban.
2011-11-05 15:17:52 -04:00
Ross Lagerwall
59142db6d3
Issue #12797 : Added custom opener parameter to builtin open() and FileIO.open().
2011-10-31 20:34:46 +02:00
Raymond Hettinger
5d12faa5b8
Merge
2011-10-30 15:07:01 -07:00
Raymond Hettinger
6f45d18c24
Improve itertools docs with clearer examples of pure python equivalent code.
2011-10-30 15:06:14 -07:00
Ezio Melotti
963004d1d8
Fix typo.
2011-10-25 09:41:13 +03:00
Ezio Melotti
c99c85899a
Remove mention of narrow/wide builds from ord/chr doc.
2011-10-25 09:32:34 +03:00
Mark Dickinson
36645681c8
Issue #13201 : equality for range objects is now based on equality of the underlying sequences. Thanks Sven Marnach for the patch.
2011-10-23 19:53:01 +01:00
Ezio Melotti
f10644983e
Merge with 3.2.
2011-10-19 11:06:26 +03:00
Ezio Melotti
e130a52d8a
Remove duplication.
2011-10-19 10:58:56 +03:00
Antoine Pitrou
62ab10a05a
Replace mentions of IOError
2011-10-12 20:10:51 +02:00
Éric Araujo
18ddf826e7
Add links from library/functions to other docs.
...
Suggested by Terry J. Reedy in #12298 .
2011-09-01 23:10:36 +02:00
Éric Araujo
9edd9f035b
Fix a few links in the table of built-in functions ( #12298 )
2011-09-01 23:08:55 +02:00
Éric Araujo
e8b7eb07e1
Link isinstance/issubclass to the ABC glossary entry ( #12256 )
2011-08-19 02:17:03 +02:00
Éric Araujo
e801aa2a1d
Let the doc of __import__ link to importlib ( #9254 ).
...
importlib.import_module eschews a number of issues that __import__ has.
Reviewed by Brett Cannon. (The docstring of __import__ was already
updated in 3d490c3a019e, for #7397.)
2011-07-29 17:50:58 +02:00
Raymond Hettinger
9d3df6d508
Issue 11889: Clarify docs for enumerate.
2011-06-25 15:00:14 +02:00
Raymond Hettinger
9028928156
Forward port doc updates for builtin functions.
2011-06-01 16:17:23 -07:00
Éric Araujo
c5069e0070
Merge doc touch-ups and fixes for #9831 and #9223 from 3.1
2011-05-29 00:29:56 +02:00
Éric Araujo
f33de71514
Minor doc addition for clarity
2011-05-27 04:42:47 +02:00
Raymond Hettinger
30439b23c0
Document default fmtspec. Fix inaccurate note. Document exceptions.
2011-05-11 10:47:27 -07:00
Georg Brandl
2a39b71ecc
Replace sys.maxint mention by sys.maxsize.
2010-12-28 09:16:12 +00:00
Georg Brandl
46402378ca
Fix markup errors.
2010-12-04 19:06:18 +00:00
Georg Brandl
8334fd9285
Add an "optimize" parameter to compile() to control the optimization level, and provide an interface to it in py_compile, compileall and PyZipFile.
2010-12-04 10:26:46 +00:00
Georg Brandl
38e117d20a
Fix punctuation.
2010-12-03 17:19:27 +00:00