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
as the original links are working again and they provide extended features such as comments and alternative versions.
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
kevin seelbach
714217f956
Fixes dead links to Django's logging config docs (GH-20823)
...
Fixes two outdated URLs to point at the current "stable" version of Django's logging documentation.
Automerge-Triggered-By: @vsajip
2020-06-14 10:23:47 -07:00
Rémi Lapeyre
7efb826c3e
Use f-strings in argparse HOWTO (GH-20070)
2020-05-20 21:22:59 -07:00
Mathieu Dupuy
65460565df
Doc: change 'Posix' for 'POSIX' (GH-20001)
2020-05-17 23:29:51 +02:00
amaajemyfren
8ea10a9446
closes bpo-40166: Change Unicode Howto so that it does not have a specific number of assigned code points. (GH-19328)
...
Change the number of code points from a specific number to a link to the latest standard that has a description of how many code points there are.
2020-04-06 23:16:02 -05:00
Benjamin Peterson
51796e5d26
Update some www.unicode.org URLs to use HTTPS. (GH-18912)
2020-03-10 21:10:59 -07:00
Slam
7598a93139
PyPy already supports Python 3 (GH-18774)
2020-03-06 11:08:17 +00:00
Julien Palard
35eac4500a
Doc: Fix external links to functional programming tutorial. (GH-18249)
2020-01-29 14:10:54 +01:00
Juhana Jauhiainen
8271441d8b
bpo-39374: Updated sorting documentation (GH-18177)
2020-01-25 14:18:58 -08:00
Oleg Höfling
e6ae90dede
Replace links in howto/pyporting.rst with sphinx references (GH-17781)
...
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
2020-01-05 17:08:14 -05:00
Vinay Sajip
5383956583
bpo-38830: Correct slot signature in Qt example. (GH-17220)
2019-11-18 12:03:22 +00:00
Serhiy Storchaka
e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
...
Also fix some other formatting.
2019-10-30 21:37:16 +02:00
Greg Price
32a960f8e1
Correct Roman-numeral example in Unicode HOWTO. (GH-15541)
2019-09-08 12:42:13 +03:00
Serhiy Storchaka
5eca7f3f38
bpo-15999: Always pass bool instead of int to socket.setblocking(). (GH-15621)
2019-09-01 12:12:52 +03:00
Raymond Hettinger
03acba6f1a
bpo-25777: Wording describes a lookup, not a call (GH-15573)
2019-08-28 22:59:43 -07:00
Ethan Furman
77df9a1573
correct roman numeral VII description (GH-15523)
2019-08-26 09:12:50 -07:00
Vinay Sajip
472eced677
Refined Qt GUI example in the logging cookbook. (GH-15045)
2019-07-31 07:36:45 +01:00
Vinay Sajip
1ed915e8ae
Add Qt GUI example to the logging cookbook. (GH-14978)
2019-07-27 13:46:53 +01:00
Vinay Sajip
d309352c6f
Update logging cookbook to show multiple worker processes using the concurrent.futures module. ( #14905 )
2019-07-22 12:14:50 +01:00
Vinay Sajip
84de34e39e
bpo-32934: Clarified meaning of 'capacity' for BufferingHandler and MemoryHandler. (GH-14498)
2019-07-01 12:41:21 +01:00
Brad
8b2aa1fdde
Use `python -m pip install` in porting guide and venv docs (GH-13257)
...
This is to help prevent people from accidentally installing into the wrong Python interpreter if they are not aware of which Python interpreter `pip` points to.
2019-06-21 11:20:21 -07:00
Vinay Sajip
ca7b504a4d
bpo-37111: Add 'encoding' and 'errors' parameters to logging.basicCon… (GH-14008)
2019-06-17 17:40:52 +01:00
Serhiy Storchaka
e042a4553e
Do not use explicit inheritance from object in the documentation. (GH-13936)
2019-06-10 13:35:52 +03:00
Serhiy Storchaka
70c5f2ae6e
Use more PEP 570 syntax in the documentation. (GH-13720)
2019-06-01 11:38:24 +03:00
Steve Dower
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
redshiftzero
f98c3c59c0
docs 36789: resolve incorrect note regarding UTF-8 (GH-13111)
2019-05-17 06:44:17 -04:00
Stéphane Wirtel
cbb6484573
Doc: Replace the deprecated highlightlang directive by highlight. ( #13377 )
...
highlightlang is deprecated since April 2018 in Sphinx.
See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 15:25:34 +05:30
redshiftzero
3b2f9ab31d
doc: fix broken link on howto/unicode page ( #13160 )
...
Thank you @redshiftzero on the first PR 👏
2019-05-10 00:43:39 +05:30
josh
a6de52c74d
bpo-32913: Added re.Match.groupdict example to regex HOWTO (GH-5821)
2019-04-17 15:43:30 -07:00
Shubham Aggarwal
abbdd1fc5c
bpo-23984: Improve descriptor documentation (GH-1034)
...
https://bugs.python.org/issue23984
2019-03-19 19:55:55 -07:00
Andrew Kuchling
97c288df61
bpo-20906: Various revisions to the Unicode howto ( #8394 )
...
* bpo-20906: Corrections & revisions to Unicode HOWTO
* bpo-34484: don't describe range as a Private Use Area
2019-03-03 23:10:28 -05:00
Raymond Hettinger
3bacf61265
bpo-35584: Clarify role of caret in a class class (GH-11946)
...
https://bugs.python.org/issue35584
2019-02-19 11:32:18 -08:00
yuji38kwmt
cda73a5af2
bpo-35781: Changed references to deprecated 'warn' method in logging documentation in favour of 'warning' (GH-11654)
2019-01-23 07:27:13 +00:00
Géry Ogam
f0c743604f
bpo-35722: Updated the documentation for the 'disable_existing_loggers' parameter (GH-11525)
2019-01-23 07:12:39 +00:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
Serhiy Storchaka
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)
2018-10-31 02:26:06 +02:00
Stéphane Wirtel
12e696b4f0
bpo-35042: Use the :pep: role where a PEP is specified ( #10036 )
2018-10-26 15:58:26 -07:00
Benjamin Peterson
12d0ff1230
Remove ">>>" from testsetup. (GH-10017)
...
Fixes doc build breakage from 890a4b9293
.
2018-10-20 16:51:05 -07:00
Xtreak
890a4b9293
bpo-35020: Link to sorting examples from list.sort() (GH-9931)
2018-10-20 14:39:03 -07:00
Vinay Sajip
1a4a10d9f1
Added CLI starter example to logging cookbook. (GH-9910)
2018-10-16 12:36:52 +01:00
Cheryl Sabella
11c4eaa993
Remove recent from logging cookbook (GH-9636)
2018-10-02 09:35:05 -07:00
Géry Ogam
5b3cbcd4a0
Improved the more elaborate multiprocessing example in the logging cookbook (GH-9326)
2018-09-25 08:24:52 +01:00
Petr Viktorin
2d3ff2b5ea
bpo-24937: Replace the extension module porting HOWTO by links to external projects (GH-9317)
2018-09-24 12:42:33 +02:00
Andrés Delfino
271818fe27
Fix "Python" casing in a few places (GH-9001)
2018-09-14 10:13:09 -07:00
NotAFile
28ea4c2847
switch descriptor howto to return value annotation (GH-7796)
2018-09-10 14:35:38 -07:00
Rémy HUBSCHER
290a60bd8a
Revert "Fix misindented yaml in logging how to example (GH-8604)" (GH-9081)
...
This reverts commit 10b59f1b01
.
2018-09-10 17:07:15 +08:00
Rémy HUBSCHER
10b59f1b01
Fix misindented yaml in logging how to example (GH-8604)
2018-08-12 16:58:26 -07:00
Sergey Fedoseev
db8707c8ab
Make code examples in Functional Programming HOWTO to be PEP 8 compliant. (GH-8646)
2018-08-07 14:38:00 -07:00
Serhiy Storchaka
7cb7bcff20
bpo-20260: Implement non-bitwise unsigned int converters for Argument Clinic. (GH-8434)
2018-07-26 13:22:16 +03:00
Stig Johan Berggren
5e5bbbec46
bpo-34083: Update dict order in Functional HOWTO (GH-8230)
2018-07-11 18:53:07 +09:00
INADA Naoki
c6cd164cff
bpo-30660: Doc: Optimize PNG files by optipng (GH-8032)
...
Using OptiPNG 0.7.7.
Used command is: `find . -name '*.png' | xargs optipng -o7`
2018-07-01 16:02:52 +09:00
Serhiy Storchaka
0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
...
85% of them are already links.
2018-05-31 07:39:00 +03:00
Aaron Hall, MBA
4054b172ab
bpo-26103: Fix inspect.isdatadescriptor() and a data descriptor definition. (GH-1959)
...
Look for '__set__' or '__delete__'.
2018-05-21 02:46:42 +03:00
Eitan Adler
9572132ab3
Docs: be less specific about python versions (GH-6985)
...
CPython 3.5 is old now, and we don't bump this version often,
so lets avoid using specific versions.
2018-05-20 17:38:01 +03:00
Stéphane Wirtel
19177fbd5d
bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814)
2018-05-15 14:58:35 -04:00
Vinay Sajip
c4994dc00d
bpo-33400: Clarified documentation to indicate no strict adherence to ISO 8601. (GH-6702)
2018-05-04 22:20:54 +01:00
Andrés Delfino
c89b221758
Remove to-be-deprecated urllib.request.urlretrieve function reference ( #6454 )
2018-04-16 07:02:56 -07:00
Serhiy Storchaka
46936d5a71
Improve highlighting of some code blocks. (GH-6401)
2018-04-08 19:18:04 +03:00
Cheryl Sabella
66771422d0
bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265)
...
Modify RE examples in documentation to use raw strings to prevent DeprecationWarning.
Add text to REGEX HOWTO to highlight the deprecation. Approved by Serhiy Storchaka.
2018-02-02 16:16:27 -05:00
Sanyam Khurana
338cd83c5d
bpo-25910: Link redirections in docs ( #1933 )
...
Fixes some redirection links in docs.
2018-01-20 01:25:37 +01:00
Serhiy Storchaka
fbb490fd2f
bpo-32308: Replace empty matches adjacent to a previous non-empty match in re.sub(). ( #4846 )
2018-01-04 11:06:13 +02:00
jimmy
4f29f3c84b
trivial: link updates in documentation ( #2765 )
2017-12-13 14:37:51 +02:00
Sanyam Khurana
1b4587a246
bpo-25910: Fixes redirection from http to https ( #4674 )
2017-12-06 17:39:33 +01:00
Mandeep Bhutani
610e5afdcb
bpo-30004: Fix the code example of using group in Regex Howto Docs (GH-4443)
...
The provided code example was supposed to find repeated words, however it returned false results.
2017-11-24 20:56:00 -08:00
Berker Peksag
12d60560ac
Add version{changed,added} markers and make minor style changes (GH-4273)
2017-11-04 15:17:56 +03:00
Serhiy Storchaka
cd195e2a7a
bpo-31714: Improved regular expression documentation. ( #3907 )
2017-10-14 11:14:26 +03:00
Serhiy Storchaka
0b5e61ddca
bpo-30397: Add re.Pattern and re.Match. ( #1646 )
2017-10-04 20:09:49 +03:00
Christian Heimes
3d2b407da0
bpo-31574: importlib dtrace ( #3749 )
...
Importlib was instrumented with two dtrace probes to profile import timing.
Signed-off-by: Christian Heimes <christian@python.org>
2017-09-29 15:53:19 -07:00
Raymond Hettinger
0d4497b9ca
bpo-23702: Update Descriptor-HOWTO to reflect the removal of unbound methods ( #3739 )
2017-09-25 01:05:49 -07:00
Pablo Galindo
586c0502b5
bpo-31294: Fix ZeroMQSocketListener and ZeroMQSocketHandler examples ( #3229 )
...
* Fix ZeroMQSocketListener and ZeroMQSocketHandler examples
* Use send_json and recv_json to simplify pyzmq interfacing
* Add News entry
2017-09-07 13:53:13 -07:00
Lisa Hewus Fresh
384899dfae
bpo-30737: Update DevGuide links to new URL (GH-3228)
...
Update old devguide links from https://docs.python.org/devguide to https://devguide.python.org
2017-08-30 09:37:43 -07:00
Brett Cannon
a3110a0133
Fix a minor grammar issue in the logging cookbook (GH-3136)
2017-08-18 10:00:31 -07:00
waxmoon
d439d3e291
Minor typo in curses.rst ( #2763 )
...
I found a tiny typo in the curses how-to: changed 'Thy' to 'The' on line 68.
2017-07-24 18:03:07 -04:00
_ = NaN
b066edfb1b
bpo-30709: Improve code example in Descriptor HowTo doc (GH-2339)
2017-06-22 20:54:35 -07:00
gfyoung
ec19ba210b
bpo-29596: Improve clinic howto documentation (GH-1710)
...
Clarify that `two-pass` buffer can only be dumped once, and it prints out all text sent to it during all processing, even from Clinic blocks *after* the dumping point.
2017-06-06 12:23:52 -07:00
Mariano Anaya
1bced56567
bpo-30530: Update Descriptor How To Documentation (GH-1845)
...
Update the code example in Functions and Methods section
Remove objtype argument in MethodType
2017-06-04 19:46:50 -07:00
csabella
9be4ff359d
bpo-30538: Update count() in Functional Programming HOWTO ( #1919 )
...
* bpo-30538: Update count() in Functional HOWTO
* bpo-30538: Update enumerate() arguments in Functional HOWTO
2017-06-04 10:39:21 -07:00
delirious-lettuce
3378b2062c
Fix typos in multiple `.rst` files ( #1668 )
2017-05-19 23:37:57 +03:00
Serhiy Storchaka
d97b7dc94b
bpo-30380: Fix Sphinx 1.6.1 warnings. ( #1613 )
...
* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS.
2017-05-16 23:18:09 +03:00
UltimateCoder
8856940cf2
bpo-28315: Improve code examples in docs (GH-1372)
...
Replace
File "<stdin>", line 1, in ?
with
File "<stdin>", line 1, in <module>
2017-05-03 09:46:45 -07:00
Jesse Gonzalez
6fde770e4e
Use the correct name for ISO in Unicode HOWTO. ( #1312 )
2017-04-26 22:12:17 -07:00
Berker Peksag
8526fb74ed
Remove redundant comma in argparse HOWTO ( #1141 )
...
Reported by Sean Canavan on docs@p.o.
2017-04-20 07:29:35 +03:00
Serhiy Storchaka
84b8e92e46
bpo-29918: Add missed "const" modifiers in C API documentation. ( #846 )
2017-03-30 10:01:03 +03:00
Martin Panter
4659ddc433
Merge doc fixes from 3.5
2017-01-14 09:54:57 +00:00
Martin Panter
8f1378366e
Avoid line breaks after hyphens, otherwise they are turned into spaces
2017-01-14 08:24:20 +00:00