Alexander Marshalov
e22072fb11
bpo-34149: Behavior of the min/max with key=None (GH-8328)
...
Improve consistency with the signature for sorted(), heapq.nsmallest(), heapq.nlargest(), and itertools.groupby().
2018-07-23 20:58:21 -07:00
Andrés Delfino
33aefad342
Doc: Point to Simple statements section instead of PEP (GH-8238)
2018-07-11 18:44:06 +09:00
Windson yang
3ae2e33a61
classify abs() argument type (GH-8103)
2018-07-05 16:09:53 -07:00
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