Ethan Furman
cb755dba7a
bpo-45740: [Enum] add versionadded markers to docs (GH-29443)
...
[Enum] add versionadded markers to docs
2021-11-06 10:16:43 -07:00
Ethan Furman
7c4d96103c
bpo-44174: [Enum] add reference to name mangling (GH-29116)
2021-10-20 20:32:11 -07:00
Hugo van Kemenade
d89fb9a5a6
bpo-45320: Remove long-deprecated inspect methods (GH-28618)
2021-10-20 20:48:55 +02:00
DonnaDia
7af95a1e80
bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity (GH-27989)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-06 16:51:55 +02:00
Rohit Nishad
977d99d1cc
Fix 404 link to the pyporting mailing list (GH-27320)
...
Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-08-04 20:53:58 +02:00
Vinay Sajip
174fbd85f6
bpo-44399: Document another example of unexpected behavior. (GH-27407)
2021-07-28 11:46:52 +01:00
Mariusz Felisiak
2e41df4d60
bpo-44740: Make minor edits to lowercasing "internet" and "web". (GH-27385)
...
Follow up to 11749e2dc2
2021-07-27 10:57:52 +02:00
Mariusz Felisiak
11749e2dc2
bpo-44740: Lowercase "internet" and "web" where appropriate. ( #27378 )
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-07-27 00:11:55 +02:00
Elliot Waite
3e5b82ed7e
Small text fixes for enum.rst ( #27322 )
...
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2021-07-26 17:59:20 +02:00
Vinay Sajip
9751f85914
bpo-44399: Update logging cookbook to document patterns to be avoided. (GH-27348)
2021-07-25 18:05:39 +01:00
E-Paine
e9f66aedf4
Remove effbot urls (GH-26308)
2021-05-22 14:09:54 +02:00
krisaoe
33d9bf298b
Fix error in Enum documentation example code that was referring to the wrong enum. ( #25837 )
2021-05-04 14:34:14 +02:00
larryhastings
49b26fa517
bpo-43987: Add "Annotations Best Practices" HOWTO doc. ( #25746 )
...
Add "Annotations Best Practices" HOWTO doc.
2021-05-01 21:19:24 -07:00
Andre Delfino
52cd6d5e1b
Use the zero argument form of super() in examples for Python3 docs. (GH-22314)
2021-04-26 15:13:54 -07:00
Raymond Hettinger
fe24088293
Add more tests. Fix code excerpt. (GH-25549)
2021-04-22 20:02:46 -07:00
Raymond Hettinger
14092b5a4a
bpo-43917: Fix pure python equivalent for classmethod (GH-25544)
...
Reported by Yahor Harunovich.
2021-04-22 17:53:36 -07:00
Raymond Hettinger
4f9ffa8f9c
Add doctests (GH-25474)
2021-04-19 14:12:36 -07:00
Victor Stinner
85918e4ab6
bpo-43774: Add more links to configure options (GH-25363)
2021-04-12 23:27:35 +02:00
Victor Stinner
a41782cc84
bpo-43774: Document configure options (GH-25283)
...
Add Doc/using/configure.rst documentation to document configure,
preprocessor, compiler and linker options.
Add a new section about the "Python debug build".
2021-04-08 22:32:21 +02:00
Raymond Hettinger
c5354c045c
Replace broken example code with correct simpler code. (GH-25162)
...
The open() was missing 'w' to indicate it was in a write-mode.
Even then, the open().close() operation was distracting because
it is an unusual way to "touch" as file. Using os.remove()
instead is simpler and less distracting.
2021-04-03 13:09:01 -07:00
Raymond Hettinger
e4c8895ee5
Add more tests for the descriptor tutorial (GH-25164)
2021-04-03 13:07:52 -07:00
Zackery Spytz
e689cdca3c
bpo-43677: Fix a minor error in Doc/howto/descriptor.rst ( #25123 )
...
It should be PyMethod_Type, not Py_MethodType.
2021-04-01 10:03:33 -07:00
Ethan Furman
b775106d94
bpo-40066: Enum: modify repr() and str() (GH-22392)
...
* Enum: streamline repr() and str(); improve docs
- repr() is now ``enum_class.member_name``
- stdlib global enums are ``module_name.member_name``
- str() is now ``member_name``
- add HOW-TO section for ``Enum``
- change main documentation to be an API reference
2021-03-30 21:17:26 -07:00
Harry
7bfd65eba7
bpo-43648: Remove redundant datefmt option in logging file config (GH-25051)
...
[bpo-43648](): Remove redundant datefmt option in logging file config
Automerge-Triggered-By: GH:vsajip
2021-03-29 07:16:19 -07:00
Raymond Hettinger
f00e82f8b8
bpo-43427: Separte the method overview from the static method specifics. (GH-24787)
2021-03-13 13:46:32 -08:00
Andrew Tennikoff
5f18c22339
Simple typo fix (GH-24448)
2021-02-05 10:17:01 -08:00
Raymond Hettinger
755c6e637a
Minor readability improvements. Also note performance impact of __slots__. (GH-24456)
2021-02-04 22:05:42 -08:00
diegoe
a98fe02d73
bpo-43082: Remove redundant 'the' in Descriptor howto (GH-24394)
2021-02-02 19:28:36 -08:00
Erlend Egeberg Aasland
e982fe496b
bpo-42048: Clinic Howto: Document AC's defining_class converter (GH-23978)
2021-01-20 12:19:57 +01:00
Yurii Karabas
c56387f80c
bpo-27794: Add name attribute to property class (GH-23967)
2020-12-30 01:51:24 -08:00
Raymond Hettinger
41b223d29c
bpo-9694: Fix misleading phrase "optional arguments" (GH-23858)
2020-12-23 09:40:56 -08:00
basak
9d09e1719c
Typo: fix inverted sense of statement (GH-23288)
...
Looks like a "not" was inadvertently omitted in commit e6a7ea4
2020-11-25 06:12:17 -08:00
Raymond Hettinger
85c84920f5
Add more tests to the descriptor howto guide (GH-23506)
2020-11-25 01:54:24 -08:00
Raymond Hettinger
2d44a6bc4f
Add doctests to the descriptor HowTo (GH-23500)
2020-11-24 20:57:02 -08:00
Raymond Hettinger
ffae93248a
Descriptor HowTo: Improve the fidelity of the member object simulation (GH-23475)
2020-11-23 10:56:59 -08:00
Raymond Hettinger
c272d40e5b
More updates to the descriptor howto guide (GH-23238)
2020-11-15 17:44:28 -08:00
Raymond Hettinger
803187796f
Minor grammar edits for the descriptor howto guide (GH-#23175)
2020-11-06 01:30:17 -08:00
Victor Stinner
4b9aad4999
bpo-42236: Enhance init and encoding documentation (GH-23109)
...
Enhance the documentation of the Python startup, filesystem encoding
and error handling, locale encoding. Add a new "Python UTF-8 Mode"
section.
* Add "locale encoding" and "filesystem encoding and error handler"
to the glossary
* Remove documentation from Include/cpython/initconfig.h: move it to
Doc/c-api/init_config.rst.
* Doc/c-api/init_config.rst:
* Document command line options and environment variables
* Document default values.
* Add a new "Python UTF-8 Mode" section in Doc/library/os.rst.
* Add warnings to Py_DecodeLocale() and Py_EncodeLocale() docs.
* Document how Python selects the filesystem encoding and error
handler at a single place: PyConfig.filesystem_encoding and
PyConfig.filesystem_errors.
* PyConfig: move orig_argv member at the right place.
2020-11-02 16:49:54 +01:00
Raymond Hettinger
e9208f0e74
Minor formatting edits to the descriptor howto guide (GH-23092)
2020-11-01 20:15:50 -08:00
Raymond Hettinger
74fa464b81
Add member objects to the descriptor howto guide (GH-23084)
2020-11-01 18:02:37 -08:00
Raymond Hettinger
148c76b27c
Expand and clarify the "Invoking Descriptors" section of the Descriptor HowTo (GH-23078)
2020-11-01 09:10:06 -08:00
Raymond Hettinger
e6a7ea4f2e
Split-out a fourth section in the descriptor HowTo guide (GH-22965)
2020-10-25 07:12:50 -07:00
Raymond Hettinger
4a9c637938
Second round of updates to the descriptor howto guide (GH-22946)
2020-10-24 20:34:39 -07:00
Raymond Hettinger
8e5b0fdce3
bpo-19072: Update descriptor howto for decorator chaining (GH-22934)
2020-10-23 18:37:27 -07:00
Raymond Hettinger
8d3d7314d4
Create a primer section for the descriptor howto guide (GH-22906)
2020-10-23 12:55:39 -07:00
Andre Delfino
e8a2076e14
Revert "Fix all Python Cookbook links ( #22205 )" (GH-22424)
...
This commit reverts commit ac0333e1e1
2020-09-27 01:47:25 +01:00
Andre Delfino
ac0333e1e1
Fix all Python Cookbook links ( #22205 )
2020-09-15 21:13:26 +01:00
Vinay Sajip
cdbff3527c
[doc] Update documentation on logging optimization. (GH-22075)
2020-09-03 19:44:12 +01:00
Victor Stinner
43577c01a2
bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858)
...
Use generic '.. object::' to declare markers, rather than abusing
'.. c:function::' which fails on Sphinx 3.
2020-08-13 19:15:38 +02:00
Yonatan Goldschmidt
f6a16e8a82
Remove incorrect mention of method.__class__ in descriptor docs (GH-21665)
2020-07-28 16:56:26 -07:00
