Commit Graph

506 Commits

Author SHA1 Message Date
Andrés Delfino bda9c3eae3 Fix the indentation in the documentation of bin() and hash() (GH-7998) 2018-06-29 12:57:10 +03:00
Andrés Delfino a8ddf85a84 bpo-33943: Add references in the docs for logging.basicConfig (GH-7858)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
2018-06-25 09:06:10 +03:00
Lisa Roach 900c48dba3 bpo-30940: Updating round() docs. (GH-6342) 2018-05-20 18:00:18 +03:00
Serhiy Storchaka df00f04825 bpo-26701: Tweak the documentation for special methods in int(). (GH-6741) 2018-05-10 23:38:44 +10:00
Julien Palard b3c369861b Fix superfluous if in documentation. (GH-6728) 2018-05-09 10:25:22 +03:00
Eric Appelt 308eab979d bpo-26701: Add documentation for __trunc__ (GH-6022)
`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
2018-03-10 18:44:12 +10:00
Brett Cannon f7a6ff6fca
Warn that compile() can crash when compiling to an AST object (GH-6043) 2018-03-09 13:13:32 -08:00
cocoatomo 2a3260bb03 Fix minor markup typo (#5407) 2018-01-29 00:30:48 -08:00
Éric Araujo 03b9537dc5 bpo-31567: more decorator markup fixes in docs (GH-3959) (#3966) 2017-10-12 12:28:55 -04:00
Daisuke Miyakawa 0e61e67a57 bpo-31567: add or fix decorator markup in docs (#3959) 2017-10-12 10:39:43 -04:00
Barry Warsaw 36c1d1f1e5 PEP 553 built-in breakpoint() function (bpo-31353) (#3355)
Implement PEP 553, built-in breakpoint() with support from sys.breakpointhook(), along with documentation and tests.  Closes bpo-31353
2017-10-05 12:11:18 -04:00
Łukasz Rogalski be37beb05f Doc that 'sorted' args are keyword-only, fix 'reverse' default (#2706) 2017-07-14 15:23:39 -04:00
Manvisha Kodali 67ba4fa467 bpo-26506: hex() documentation: mention %x % int (GH-2525) 2017-07-06 12:30:58 -07:00
Marco Buttu e65fcde85a bpo-27200: Fix several doctests (GH-604) 2017-04-27 15:23:34 +03:00
csabella c6db4811f9 bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271)
Builtin container types have two potential link targets in the docs:

- their entry in the list of builtin callables
- their type documentation

This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry.
2017-04-26 15:47:01 +10:00
Joshua Diaddigo 873ef20d00 Fix a typo in Doc/library/functions.rst (GH-1117)
Replace `For object's ... ` with `For objects ...`
2017-04-13 10:31:37 -07:00
Berker Peksag 61b9ac9371 bpo-29791: Clarify that flush is keyword-only argument (#1093)
Reported by Lucio Ricardo Montero Valenzuela.
2017-04-13 15:48:18 +03:00
csabella 85deefcf61 bpo-29677: DOC: clarify documentation for `round` (GH-877) 2017-03-29 14:14:06 -07:00
Gerrit Holl 6003db7db5 bpo-29677: DOC: clarify documentation for `round` (#357)
* DOC: clarify documentation for `round`

Clarified that `round` can take a negative value for *ndigits*.

* DOC: remove trailing whitespace in previous commit

remove trailing whitespace in previous commit
2017-03-28 00:15:20 +02:00
NAKAMURA Osamu 29540cdf6c bpo-29892: Fix wrong markup on doc-lib-functions (GH-802) 2017-03-24 19:55:08 -07:00
Serhiy Storchaka 0264e46caa Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:49:59 +02:00
Serhiy Storchaka c7b1a0bbe2 Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges
in the documentation.
2016-11-26 13:43:28 +02:00
Martin Panter 99b6f28351 Merge doc fixups from 3.5 2016-11-21 04:22:22 +00:00
Martin Panter 357ed2e577 Change double hyphens (en dashes) to em (longer) dashes 2016-11-21 00:15:20 +00:00
Brett Cannon a721abac29 Issue #26331: Implement the parsing part of PEP 515.
Thanks to Georg Brandl for the patch.
2016-09-09 14:57:09 -07:00
Raymond Hettinger 871a3340b7 Issue 27936: Update doc for round() to indicate that None is an allowable argument. 2016-09-04 11:28:56 -07:00
Steve Dower 3929499914 Issue #1602: Windows console doesn't input or print Unicode (PEP 528)
Closes #17602: Adds a readline implementation for the Windows console
2016-08-30 21:22:36 -07:00
Brett Cannon 6fa7aada9b Issue #26027, #27524: Document the support for path-like objects in os and os.path.
This completes PEP 519.
2016-09-06 15:55:02 -07:00
Raymond Hettinger bce9cbaf98 Merge 2016-09-04 11:29:13 -07:00
Berker Peksag 3f015a64b8 Issue #27157: Make only type() itself accept the one-argument form
Patch by Eryk Sun and Emanuel Barry.
2016-08-19 11:04:07 +03:00
Berker Peksag 69da9c4343 Issue #26547: Merge from 3.5 2016-06-24 09:12:20 +03:00
Berker Peksag 37e87e6ec1 Issue #26547: Remove outdated term dictproxy from vars() documentation
dictproxy was used in Python 2 and it was renamed to mappingproxy
in Python 3.3.

Patch by Julien.
2016-06-24 09:12:01 +03:00
Martin Panter 2fec611a70 Issue #24314: Merge doc links from 3.5 2016-06-18 08:20:22 +00:00
Martin Panter bae5d81f5d Issue #24314: Fix doc links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Brett Cannon b08388d5f2 Issue #27182: Document os.PathLike.
Part of PEP 519.
2016-06-09 15:58:06 -07:00
Ethan Furman d62548afed issue27186: add open/io.open; patch by Jelle Zijlstra 2016-06-04 14:38:43 -07: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 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
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
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
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
Senthil Kumaran fcb6db50d3 merge from 3.4
Issue25917 : Fix howto links in docs. Point the reference documentation instead of wiki.
2016-01-01 23:26:53 -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
Martin Panter 2eb819f7a8 Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5 2015-11-02 04:04:57 +00: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
Terry Jan Reedy 44b1020c12 Merge with 3.4 2015-10-28 03:15:20 -04:00
Terry Jan Reedy 68b6874f59 Issue #25432: Explain isinstance behaviour when type is a tuple. 2015-10-28 03:14:56 -04:00
Terry Jan Reedy c7792160dd Merge with 3.4 2015-05-23 16:16:46 -04:00
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
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
Nick Coghlan 37ee850b10 Issue 2690: Add support for slicing and negative indices to range objects (includes precalculation and storage of the range length).
Refer to the tracker issue for the language moratorium implications of this change
2010-12-03 14:26:13 +00:00
Ezio Melotti 1de911592e Add callable() to the built-in functions table. 2010-11-28 04:18:54 +00:00
Antoine Pitrou e71362d3de Issue #10518: Bring back the callable() builtin.
Approved by Guido (BDFL) and Georg (RM).
2010-11-27 22:00:11 +00:00
Georg Brandl ab32fec83c Merged revisions 85572-85573,85606,85609-85622,85624,85626-85627,85629,85631,85633,85635-85636,85638-85639,85641-85642 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r85572 | georg.brandl | 2010-10-16 20:51:05 +0200 (Sa, 16 Okt 2010) | 1 line

  #10122: typo fix.
........
  r85573 | georg.brandl | 2010-10-16 20:53:08 +0200 (Sa, 16 Okt 2010) | 1 line

  #10124: typo fix.
........
  r85606 | georg.brandl | 2010-10-17 08:32:59 +0200 (So, 17 Okt 2010) | 1 line

  #10058: tweak wording about exception returns.
........
  r85609 | georg.brandl | 2010-10-17 11:19:03 +0200 (So, 17 Okt 2010) | 1 line

  #8556: use less confusing mapping key in example.
........
  r85610 | georg.brandl | 2010-10-17 11:23:05 +0200 (So, 17 Okt 2010) | 1 line

  #8686: remove potentially confusing wording that does not add any value.
........
  r85611 | georg.brandl | 2010-10-17 11:33:24 +0200 (So, 17 Okt 2010) | 1 line

  #8811: small fixes to sqlite3 docs.
........
  r85612 | georg.brandl | 2010-10-17 11:37:54 +0200 (So, 17 Okt 2010) | 1 line

  #8855: add shelve security warning.
........
  r85613 | georg.brandl | 2010-10-17 11:43:35 +0200 (So, 17 Okt 2010) | 1 line

  Fix hmac docs: it takes and returns bytes, except for hexdigest().
........
  r85614 | georg.brandl | 2010-10-17 11:46:11 +0200 (So, 17 Okt 2010) | 1 line

  #8968: add actual name of token constants.
........
  r85615 | georg.brandl | 2010-10-17 12:05:13 +0200 (So, 17 Okt 2010) | 1 line

  #459007: merge info from PC/getpathp.c and using/windows.rst to document the forming of sys.path under Windows.
........
  r85616 | georg.brandl | 2010-10-17 12:07:29 +0200 (So, 17 Okt 2010) | 1 line

  Fix copy-paste error in example.
........
  r85617 | georg.brandl | 2010-10-17 12:09:06 +0200 (So, 17 Okt 2010) | 1 line

  #5212: md5 weaknesses do not affect hmac, so remove the note about that.
........
  r85618 | georg.brandl | 2010-10-17 12:14:38 +0200 (So, 17 Okt 2010) | 1 line

  #9086: correct wrong terminology about linking with pythonXY.dll.
........
  r85619 | georg.brandl | 2010-10-17 12:15:50 +0200 (So, 17 Okt 2010) | 1 line

  Make file names consistent.
........
  r85620 | georg.brandl | 2010-10-17 12:22:28 +0200 (So, 17 Okt 2010) | 1 line

  Remove second parser module example; it referred to non-readily-available example files, and this kind of discovery is much better done with the AST nowadays anyway.
........
  r85621 | georg.brandl | 2010-10-17 12:24:54 +0200 (So, 17 Okt 2010) | 1 line

  #9105: move pickle warning to a bit more prominent location.
........
  r85622 | georg.brandl | 2010-10-17 12:28:04 +0200 (So, 17 Okt 2010) | 1 line

  #9112: document error() and exit() methods of ArgumentParser.
........
  r85624 | georg.brandl | 2010-10-17 12:34:28 +0200 (So, 17 Okt 2010) | 1 line

  Some markup and style fixes in argparse docs.
........
  r85626 | georg.brandl | 2010-10-17 12:38:20 +0200 (So, 17 Okt 2010) | 1 line

  #9117: fix syntax for class definition.
........
  r85627 | georg.brandl | 2010-10-17 12:44:11 +0200 (So, 17 Okt 2010) | 1 line

  #9138: reword introduction to classes in Python.
........
  r85629 | georg.brandl | 2010-10-17 12:51:45 +0200 (So, 17 Okt 2010) | 1 line

  #5962: clarify sys.exit() vs. threads.
........
  r85631 | georg.brandl | 2010-10-17 12:53:54 +0200 (So, 17 Okt 2010) | 1 line

  Fix capitalization.
........
  r85633 | georg.brandl | 2010-10-17 12:59:41 +0200 (So, 17 Okt 2010) | 1 line

  #9204: remove mentions of removed types in the types module.
........
  r85635 | georg.brandl | 2010-10-17 13:03:22 +0200 (So, 17 Okt 2010) | 1 line

  #5121: fix claims about default values leading to segfaults.
........
  r85636 | georg.brandl | 2010-10-17 13:06:14 +0200 (So, 17 Okt 2010) | 1 line

  #9237: document sys.call_tracing().
........
  r85638 | georg.brandl | 2010-10-17 13:13:37 +0200 (So, 17 Okt 2010) | 1 line

  Port changes to pickle docs apparently lost in py3k.
........
  r85639 | georg.brandl | 2010-10-17 13:23:56 +0200 (So, 17 Okt 2010) | 1 line

  Make twisted example a bit more logical.
........
  r85641 | georg.brandl | 2010-10-17 13:29:07 +0200 (So, 17 Okt 2010) | 1 line

  Fix documentation of dis.opmap direction.
........
  r85642 | georg.brandl | 2010-10-17 13:36:28 +0200 (So, 17 Okt 2010) | 1 line

  #9730: fix example.
........
2010-11-26 08:49:15 +00:00
Ezio Melotti 3188b2082e Merged revisions 86737 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86737 | ezio.melotti | 2010-11-25 00:02:18 +0200 (Thu, 25 Nov 2010) | 1 line

  Add NEWS entry for r86732 and fix double function in the table.
........
2010-11-24 22:04:22 +00:00
Ezio Melotti 17f9b3d289 Add NEWS entry for r86732 and fix double function in the table. 2010-11-24 22:02:18 +00:00
Ezio Melotti 42cc06ebf4 Merged revisions 86732 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86732 | ezio.melotti | 2010-11-24 22:18:02 +0200 (Wed, 24 Nov 2010) | 1 line

  #10299: Add a table that lists all the built-in functions in functions.rst
........
2010-11-24 20:54:01 +00:00
Ezio Melotti f21c7ed39d #10299: Add a table that lists all the built-in functions in functions.rst 2010-11-24 20:18:02 +00:00