2edaf6a4fb
bpo-8264: Document hasattr and getattr behavior for private attributes (GH-23513)
...
Clarify ``getattr`` and ``setattr`` requirements for accessing name-mangled attributes
Co-Authored-By: Catalin Iacob <iacobcatalin@gmail.com>
2021-02-02 13:06:57 -08:00
5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)
2021-01-25 15:46:06 +01:00
644d52818a
bpo-40304: Correct type(name, bases, dict) doc (GH-19553)
...
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
2021-01-22 00:47:23 -05:00
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
...
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
2020-12-16 17:37:28 -08:00
fc3dca3e16
Clarify eval() doc from library/functions. (GH-22700)
2020-12-16 16:45:19 +01:00
b76a840021
bpo-42180: fix plural in arguments and control (GH-23015)
...
https://bugs.python.org/issue42180
2020-10-29 20:48:21 +00:00
0f25c231b3
Add a link to buffer protocol in bytearray() doc (GH-22675)
2020-10-26 14:26:34 +09:00
3f7e990fd4
bpo-41192: Add documentation of undocumented audit events (GH-21308)
2020-10-20 15:23:15 -04:00
155938907c
bpo-40484: Document compiler flags under AST module (GH-19885)
...
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
2020-10-19 02:14:11 +01:00
e799aa8b92
bpo-41887: omit leading spaces/tabs on ast.literal_eval ( #22469 )
...
Also document that eval() does this (the same way).
2020-10-03 17:46:44 -07:00
c8bb24166e
[doc] Update references to NumPy (GH-22458)
...
Numeric(al) Python to NumPy. It seems the old name hasn't been used for some time.
2020-10-01 16:22:14 -07:00
8af239eacf
bpo-41762: Fix usage of productionlist markup in the doc (GH-22281)
...
Use an unique identifier for the different grammars documented using
the Sphinx productionlist markup.
productionlist markups of the same grammar, like "expressions" or
"compound statements", use the same identifier "python-grammar".
2020-09-18 09:10:15 +02:00
802726acf6
Document vars behavior when __dict__ is missing ( #21466 )
2020-08-21 19:29:34 -03:00
705f145565
Doc: Add a link to tutorial page from `open()` doc (GH-21737)
...
Adds a link to the "Reading and Writing Files" page so users can
more easily discover how file handles are handled with the `with`
context manager vs without it.
2020-08-08 11:57:03 +09:00
a908bc4dd8
Doc: Builtins functions: faster jump table (GH-21376)
2020-07-09 11:38:41 +02:00
77ed29b2c2
Fix typo in functions.rst (GH-21131)
2020-06-25 14:50:37 -07:00
59cf853332
bpo-40636: Documentation for zip-strict ( #20961 )
2020-06-19 13:39:22 -07:00
2831642212
Indicate that abs() method accept argument that implement __abs__(), just like call() method in the docs (GH-20509)
2020-05-29 07:35:34 -04:00
c691f20952
Fix "versionchanged" for pow named arguments (GH-19042)
...
The ability to use named arguments in "pow" was introduced in Python 3.8, not Python 3.9. See https://bugs.python.org/issue38237
2020-03-19 18:12:59 +00:00
fc72ab6913
bpo-38691: importlib ignores PYTHONCASEOK if -E is used (GH-18627)
...
The importlib module now ignores the PYTHONCASEOK
environment variable when the -E or -I command line
options are being used.
2020-03-09 12:57:53 +01:00
942f7a2dea
bpo-39674: Revert "bpo-37330: open() no longer accept 'U' in file mode (GH-16959)" (GH-18767)
...
This reverts commit e471e72977
2020-03-04 18:50:22 +01:00
4dee92b0ad
Revert "bpo-38691 Added a switch to ignore PYTHONCASEOK when -E or -I flags passed ( #18314 )" (GH-18553)
...
This reverts commit d83b6600b2
2020-02-19 14:23:47 +01:00
d83b6600b2
bpo-38691 Added a switch to ignore PYTHONCASEOK when -E or -I flags passed ( #18314 )
...
* Hard reset + cherry piciking the changes.
* 📜 🤖 Added by blurb_it.
* Added @vstinner News
* Update Misc/NEWS.d/next/Library/2020-02-11-13-01-38.bpo-38691.oND8Sk.rst
Co-Authored-By: Victor Stinner <vstinner@python.org>
* Hard reset to master
* Hard reset to master + latest changes
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2020-02-17 10:05:11 +01:00
d7c7adde00
bpo-12159: Document sys.maxsize limit in len() function reference (GH-17934)
2020-01-12 10:04:14 +01:00
ee9ff05ec2
bpo-34118: memoryview, range, and tuple are classes (GH-17761)
...
Tag memoryview, range, and tuple as classes, the same as list, etcetera, in
the library manual built-in functions list.
2019-12-30 17:16:43 -05:00
d67279147a
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
2019-11-20 18:10:19 -08:00
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "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>".
2019-11-12 16:57:03 +02:00
e471e72977
bpo-37330: open() no longer accept 'U' in file mode (GH-16959)
...
open(), io.open(), codecs.open() and fileinput.FileInput no longer
accept "U" ("universal newline") in the file mode. This flag was
deprecated since Python 3.3.
2019-10-28 15:40:08 +01:00
15ccc4fac0
bpo-38255: super() can search attributes as well as methods (GH-16368)
...
Improvement suggested by Géry Ogam.
2019-09-25 08:13:19 -07:00
87d6cd3604
bpo-38237: Make pow's arguments have more descriptive names and be keyword passable (GH-16302)
...
Edit: `math.pow` changes removed on Mark's request.
https://bugs.python.org/issue38237
Automerge-Triggered-By: @rhettinger
2019-09-20 21:28:49 -07:00
7a0023e8d1
bpo-25810: Clarify eval() docs, it does not keywords (GH-15173)
2019-09-11 05:30:04 -05:00
05184515f9
Correct minor grammatical mistake in open docs (GH-15865)
2019-09-10 15:48:05 +01:00
c1d8c1cb8e
Note regarding + mode truncation applies to both text and binary mode ( #11314 )
...
* Improve doc on open's mode +
* Improve wording
* Address comment from Rémi
2019-09-10 14:04:22 +01:00
cd81f0500f
bpo-23674: Clarify ambiguities in super() docs ( #15564 )
2019-08-29 00:44:02 -07:00
805f8f9afe
bpo-19072: Make @classmethod support chained decorators (GH-8405)
2019-08-24 15:37:25 -07:00
610a4823cc
bpo-37646: Document that eval() cannot access nested scopes (GH-15117)
2019-08-06 17:56:22 -07:00
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
2019-06-27 10:47:59 -07:00
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301)
2019-06-24 08:42:54 -07:00
c4c421d619
bpo-37134: Use PEP570 syntax for sum() (GH-13851)
2019-06-06 00:11:46 +01: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
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
29540cdf6c
bpo-29892: Fix wrong markup on doc-lib-functions (GH-802)
2017-03-24 19:55:08 -07:00
0264e46caa
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:49:59 +02:00
c7b1a0bbe2
Issue #28763 : Use double hyphens (rendered as en-dashes) in numerical ranges
...
in the documentation.
2016-11-26 13:43:28 +02:00
99b6f28351
Merge doc fixups from 3.5
2016-11-21 04:22:22 +00:00
357ed2e577
Change double hyphens (en dashes) to em (longer) dashes
2016-11-21 00:15:20 +00:00
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
871a3340b7
Issue 27936: Update doc for round() to indicate that None is an allowable argument.
2016-09-04 11:28:56 -07:00
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
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
bce9cbaf98
Merge
2016-09-04 11:29:13 -07:00
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
69da9c4343
Issue #26547 : Merge from 3.5
2016-06-24 09:12:20 +03:00
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
2fec611a70
Issue #24314 : Merge doc links from 3.5
2016-06-18 08:20:22 +00:00
bae5d81f5d
Issue #24314 : Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
b08388d5f2
Issue #27182 : Document os.PathLike.
...
Part of PEP 519.
2016-06-09 15:58:06 -07:00
d62548afed
issue27186: add open/io.open; patch by Jelle Zijlstra
2016-06-04 14:38:43 -07:00
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
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
01a9a958b6
Issue #26525 : Change chr example to match change in ord example.
2016-03-23 13:36:52 -04:00
063d48d9c0
Issue #26525 : Change ord example from nu to more easily recognized Euro sign.
2016-03-20 21:18:40 -04:00
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
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
Ken Jin
Julien Palard
Борис Верховский
Andre Delfino
Antoine
Rafael Fontenelle
Saiyang Gou
Batuhan Taskaya
Victor Stinner
Benjamin Kane
Ram Rachum
Windson yang
Mark Dickinson
idomic
Zac Hatfield-Dodds
Terry Jan Reedy
Géry Ogam
Serhiy Storchaka
Raymond Hettinger
Ammar Askar
smokephil
Berker Peksag
Steve Dower
Pablo Galindo
Anthony Shaw
Steve Dower
Matthias Bussonnier
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)
Lysandros Nikolaou
Cristian Ciupitu
Nick Coghlan
Chris Rands
Wolfgang Maier
Louis Sautier
Alexander Marshalov
Lisa Roach
Eric Appelt
Brett Cannon
cocoatomo
Éric Araujo
Daisuke Miyakawa
Barry Warsaw
Łukasz Rogalski
Manvisha Kodali
Marco Buttu
csabella
Joshua Diaddigo
Gerrit Holl
NAKAMURA Osamu
Martin Panter
Brett Cannon
Raymond Hettinger
Ethan Furman
R David Murray
Georg Brandl