23f9be24bc
Update functions.rst (GH-16468)
...
This PR will make the following changes to the [_Built-in Functions_](https://docs.python.org/3/library/functions.html ) chapter of the library documentation:
- improve hyperlinks in Sphinx roles (trailing 's' belong to hyperlinks).
Automerge-Triggered-By: @csabella
(cherry picked from commit d67279147a
2019-11-20 18:17:51 -08:00
d360346640
[3.8] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17125)
...
* "Return true/false" is replaced with "Return ``True``/``False``"
if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
(cherry picked from commit 138ccbb022
2019-11-12 18:54:10 +02:00
1d2862a323
bpo-37330: open(): "U" mode is removed in Python 3.9 (GH-16972)
...
Update open() documentation.
2019-10-29 10:32:39 +01:00
7444a5a402
bpo-38255: super() can search attributes as well as methods (GH-16368) (GH-16391)
...
Improvement suggested by Géry Ogam.
(cherry picked from commit 15ccc4fac0
2019-09-25 08:24:12 -07:00
37bc935523
bpo-38237: Let pow() support keyword arguments (GH-16302) (GH-16320)
...
Backported with release manager approval
2019-09-21 01:22:29 -07:00
4e914ab29f
bpo-25810: Clarify eval() docs, it does not keywords (GH-15173)
...
(cherry picked from commit 7a0023e8d1
2019-09-11 03:53:16 -07:00
30a8fd7e73
Correct minor grammatical mistake in open docs (GH-15865)
...
(cherry picked from commit 05184515f9
2019-09-10 09:24:06 -07:00
8072230882
Note regarding + mode truncation applies to both text and binary mode (GH-11314) (GH-15869)
...
* Improve doc on open's mode +
* Improve wording
* Address comment from Rémi
(cherry picked from commit c1d8c1cb8e
2019-09-10 16:04:56 +01:00
43b7ed77a8
bpo-23674: Clarify ambiguities in super() docs (GH-15564) (GH-15586)
...
(cherry picked from commit cd81f0500f
2019-08-29 01:02:58 -07:00
9341dcb4b9
bpo-37646: Document that eval() cannot access nested scopes (GH-15117) (GH-15155)
...
(cherry picked from commit 610a4823cc
2019-08-06 18:07:59 -07:00
4fee28aa42
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
(cherry picked from commit 44f91c388a
2019-06-27 11:07:16 -07:00
8763d43a95
bpo-37363: Add audit events for a range of modules (GH-14301)
...
(cherry picked from commit 60419a7e96
2019-06-24 09:09:47 -07:00
23f41a64ea
bpo-37134: Use PEP570 syntax for sum() (GH-13851)
...
(cherry picked from commit c4c421d619
2019-06-05 16:21:08 -07:00
c52996785a
bpo-36027: Extend three-argument pow to negative second argument (GH-13266)
2019-06-02 10:24:06 +01:00
bdbad71b9d
bpo-20092. Use __index__ in constructors of int, float and complex. (GH-13108)
2019-06-02 00:05:48 +03:00
059b9ea5ac
bpo-31968: Documentation -- add clarification on the globals dict for exec() (GH-13140)
2019-06-01 08:51:58 -07:00
b82e17e626
bpo-36842: Implement PEP 578 (GH-12613)
...
Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
2019-05-23 08:45:22 -07:00
565b4f1ac7
bpo-34616: Add PyCF_ALLOW_TOP_LEVEL_AWAIT to allow top-level await (GH-13148)
...
Co-Authored-By: Yury Selivanov <yury@magic.io>
2019-05-21 16:12:02 -04:00
1c5fa5af8a
bpo-32413: Add documentation that at the module level, locals(), globals() are the same dictionary (GH-5004)
...
https://bugs.python.org/issue32413
2019-04-02 10:58:50 -07:00
548cb6060a
bpo-34085: Improve wording on classmethod/staticmethod ( #8228 )
...
* bpo-34085: Improve wording on classmethod/staticmethod
* Address comments from Éric
* Address comments from Éric
2019-03-25 18:53:43 -04:00
1aeeaeb79e
bpo-21314: Add a FAQ entry about positional only parameters (GH-10641)
2019-03-10 21:30:11 +10:00
11fa0e48a9
Doc: fix example for iter() function. (GH-11959)
...
read() returns bytes for a file opened in binary mode,
so b'' should be used as a sentinel instead of ''.
Otherwise the loop will be infinite.
2019-02-21 09:53:06 +02:00
3171df3414
Clarify U-mode deprecation in open() (GH-11646)
...
The previous wording could be read as saying that universal
newlines mode itself was deprecated, when it's only the 'U'
character in the mode field that should be avoided.
The update also moves the description of the 'U' mode character
out of the mode table, as the longer explanation was overly
intrusive as a table entry and overshadowed the actually useful
mode characters.
2019-01-28 02:21:11 +10:00
d378b1f8ed
bpo-34764: improve docs example of iter() with sentinel value (GH-11222)
2018-12-23 21:07:17 -08:00
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
6bdb6f7675
fix dangling keyfunc examples in documentation of heapq and sorted ( #1432 )
...
* fix dangling mention of key=str.lower in heapq doc
* Fix dangling mention of keyfunc example for sorted()
2018-10-15 13:06:53 -06:00
9dfa0fe587
bpo-34637: Make the *start* argument for *sum()* visible as a keyword argument. (GH-9208)
2018-09-12 10:54:06 -07:00
3fe89dac42
bpo-34434: Update doc for bool(), float() and int() arguments (GH-8834)
2018-08-27 18:45:26 +08:00
225b055480
bpo-22057: Clarify eval() documentation (GH-8812)
...
If a globals dictionary without a '__builtins__' key is passed to
eval(), a '__builtins__' key will be inserted to the dictionary:
>>> eval("print('__builtins__' in globals())", {})
True
(As a result of this behavior, we can use the builtins
print() and globals() even if we passed a dictionary without a
'__builtins__' key to eval().)
2018-08-19 13:25:33 +03:00
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
33aefad342
Doc: Point to Simple statements section instead of PEP (GH-8238)
2018-07-11 18:44:06 +09:00
3ae2e33a61
classify abs() argument type (GH-8103)
2018-07-05 16:09:53 -07:00
bda9c3eae3
Fix the indentation in the documentation of bin() and hash() (GH-7998)
2018-06-29 12:57:10 +03:00
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
900c48dba3
bpo-30940: Updating round() docs. (GH-6342)
2018-05-20 18:00:18 +03:00
df00f04825
bpo-26701: Tweak the documentation for special methods in int(). (GH-6741)
2018-05-10 23:38:44 +10:00
b3c369861b
Fix superfluous if in documentation. (GH-6728)
2018-05-09 10:25:22 +03:00
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
f7a6ff6fca
Warn that compile() can crash when compiling to an AST object (GH-6043)
2018-03-09 13:13:32 -08:00
2a3260bb03
Fix minor markup typo ( #5407 )
2018-01-29 00:30:48 -08:00
03b9537dc5
bpo-31567: more decorator markup fixes in docs (GH-3959) ( #3966 )
2017-10-12 12:28:55 -04:00
0e61e67a57
bpo-31567: add or fix decorator markup in docs ( #3959 )
2017-10-12 10:39:43 -04:00
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
be37beb05f
Doc that 'sorted' args are keyword-only, fix 'reverse' default ( #2706 )
2017-07-14 15:23:39 -04:00
67ba4fa467
bpo-26506: hex() documentation: mention %x % int (GH-2525)
2017-07-06 12:30:58 -07:00
e65fcde85a
bpo-27200: Fix several doctests (GH-604)
2017-04-27 15:23:34 +03:00
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
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
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
85deefcf61
bpo-29677: DOC: clarify documentation for `round` (GH-877)
2017-03-29 14:14:06 -07:00
Miss Islington (bot)
Serhiy Storchaka
Victor Stinner
Mark Dickinson
Anthony Shaw
Steve Dower
Matthias Bussonnier
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)
Andre Delfino
Lysandros Nikolaou
Cristian Ciupitu
Nick Coghlan
Chris Rands
Wolfgang Maier
Raymond Hettinger
Louis Sautier
Berker Peksag
Alexander Marshalov
Windson yang
Lisa Roach
Julien Palard
Eric Appelt
Brett Cannon
cocoatomo
Éric Araujo
Daisuke Miyakawa
Barry Warsaw
Łukasz Rogalski
Manvisha Kodali
Marco Buttu
csabella
Joshua Diaddigo