Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
123,024 Commits 6 Branches 593 Tags 2.5 GiB
Commit Graph

943 Commits

Author SHA1 Message Date
Vinay Sajip dc54193095
[doc] Update cookbook example and add information about queue types. (GH-94854) 2022-07-15 06:03:58 +01:00
Petr Viktorin e6ec6f5b50
Docs: Convert PEP 630 (Isolating Extension Modules) to a HOWTO (GH-94489) 
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2022-07-05 16:37:28 +02:00
Ned Batchelder 3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) 
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
 2022-07-05 11:16:10 +02:00
Vinay Sajip a391b74dbe
Update logging documentation: change cross-reference and add webapp r… (GH-94540) 2022-07-04 06:06:43 +01:00
Stanley c57a1c76d7
bpo-39971: Change examples to be runnable (GH-32172) 2022-06-25 21:51:26 +01:00
Oleg Iarygin f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853) 2022-06-21 20:55:18 +02:00
Vinay Sajip e974b3e333
Improve logging documentation with example and additional cookbook re… (GH-93644) 2022-06-09 16:43:35 +01:00
CAM Gerlach a5ba0f4ebc
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) 2022-06-09 15:55:06 +02:00
Adrian Garcia Badaracco 296081a7ce
gh-92592: Allow logging filters to return a LogRecord. (GH-92591) 2022-06-07 16:53:57 +01:00
Vinay Sajip 132e563703
[doc] Improve discoverability of links between logging documents. (GH-93405) 2022-06-01 08:29:13 +01:00
Moshe Kaplan e6e81602f4
[doc] logging.rst - Change link to point directly to the Google Group. (GH-93390) 2022-05-31 22:46:52 +01:00
jackh-ncl cc377063ef
gh-91513: Add 'asyncio' taskName to logging LogRecord attributes. (GH-93193) 2022-05-26 09:30:51 +01:00
Nicolas Haller 2176898308
gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) 2022-05-23 20:18:43 +01:00
slateny 3e3e8976b8
bpo-9182: Add a section on specifying positional arguments (#31810) 2022-05-13 09:17:07 -05:00
Julien Palard 664aa94b57
Document Py_ssize_t. (GH-92512) 
It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But
there's 8182 errors left.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
 2022-05-13 14:10:16 +02:00
Inada Naoki f9c9354a7a
gh-92536: PEP 623: Remove wstr and legacy APIs from Unicode (GH-92537) 2022-05-12 14:48:38 +09:00
Raymond Hettinger ebaf0945f9
GH-89519: Deprecate classmethod descriptor chaining (#92379) 2022-05-06 02:57:53 -05:00
Carl Meyer 7d7a378c1a
Fix typo in Sorting howto (#92280) 
The phrase is usually "odds and ends," not "odd and ends."
 2022-05-03 21:38:29 -06:00
slateny 53ca774497
sorting howto: Add clarification on < using __lt__ (#92010) 2022-04-29 16:08:07 -06:00
Inada Naoki 1317b70f89
gh-91156: Use `locale.getencoding()` instead of getpreferredencoding (GH-91732) 
Co-authored-by: Victor Stinner <vstinner@python.org>
 2022-04-22 10:39:24 +09:00
Mathieu Dupuy f82f9ce323
Remove python2 support in logging cookbook example. (GH-32362) 2022-04-06 17:57:54 +01:00
Mike cm 43571a3eea
bpo-32658: Regex docs: Fix metacharacter reference (GH-32230) 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
 2022-04-04 19:46:54 -07:00
Dave Goncalves 8be7c2bc5a
bpo-14911: Corrected generator.throw() documentation (GH-32207) 
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
 2022-03-31 16:56:48 +03:00
Serhiy Storchaka c6cd3cc93c
bpo-47081: Replace "qualifiers" with "quantifiers" in the re module documentation (GH-32028) 
It is a more commonly used term.
 2022-03-22 11:44:47 +02:00
Yuxin Wu fc44b8136f
[doc] Add a note in howto/logging.rst about "do not log to root logger in libraries" (GH-31271) 2022-02-26 18:29:51 +00:00
Raymond Hettinger 12a2e41e8a
Improve discussion about how __getattr__ is invoked. (GH-31435) 2022-02-19 23:02:30 -06:00
Alex-Blade 0cb765b2ce
bpo-46730: Add more info to @property AttributeError messages (GH-31311) 
On `obj.read_only_property = x`, raise `AttributeError: property 'read_only_property' of 'A' object has no setter`.
 2022-02-16 02:07:34 -05:00
Petr Viktorin 204946986f
bpo-46613: Add PyType_GetModuleByDef to the public API (GH-31081) 
* Make PyType_GetModuleByDef public (remove underscore)

Co-authored-by: Victor Stinner <vstinner@python.org>
 2022-02-11 17:22:11 +01:00
Manish Kumar ⛄ ba650af7d6
Optimize images by IMGbot (GH-21348) 
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
 2022-02-04 15:49:43 +09:00
Julien Palard bcafab849e
[doc]: Spotted errors while working on rstlint. (GH-30879) 
Also ignored some `make suspicious` false positives while assuring
true positives were properly seen by rstlint.
 2022-01-27 08:57:43 +01:00
Piotr Fusik d05a66339b
no-issue: Fix documentation typos. (GH-30576) 2022-01-20 17:17:15 +09:00
Kumar Aditya 83d544b929
bpo-40066: [Enum] skip failing doc test (GH-30637) 2022-01-17 07:18:13 -08:00
Victor Stinner 42a64c03ec
Revert "bpo-40066: [Enum] update str() and format() output (GH-30582)" (GH-30632) 
This reverts commit acf7403f9b.
 2022-01-17 13:58:40 +01:00
Ethan Furman acf7403f9b
bpo-40066: [Enum] update str() and format() output (GH-30582) 
Undo rejected PEP-663 changes:

- restore `repr()` to its 3.10 status
- restore `str()` to its 3.10 status

New changes:

- `IntEnum` and `IntFlag` now leave `__str__` as the original `int.__str__` so that str() and format() return the same result
- zero-valued flags without a name have a slightly changed repr(), e.g. `repr(Color(0)) == '<Color: 0>'`
- update `dir()` for mixed-in types to return all the methods and attributes of the mixed-in type
- added `_numeric_repr_` to `Flag` to control display of unnamed values
- enums without doc strings have a more comprehensive doc string added
- `ReprEnum` added -- inheriting from this makes it so only `__repr__` is replaced, not `__str__` nor `__format__`; `IntEnum`, `IntFlag`, and `StrEnum` all inherit from `ReprEnum`
 2022-01-15 22:41:43 -08:00
Nikita Sobolev 6223cbf86a
bpo-45331: [Enum] add rule to docs that mixin type must be subclassable (GH-30521) 2022-01-10 15:42:45 -08:00
Alex Waygood b2afdc95cc
bpo-45535: Improve output of Enum ``dir()`` (GH-29316) 
Modify the ``EnumType.__dir__()`` and ``Enum.__dir__()`` to ensure
that user-defined methods and methods inherited from mixin classes always
show up in the output of `help()`. This change also makes it easier for
IDEs to provide auto-completion.
 2021-12-02 08:49:52 -08:00
Vinay Sajip 39b60ceae8
[Doc] Add info to logging cookbook about running logging socket listeners i… (GH-29838) 2021-11-29 13:06:52 +00:00
Guido van Rossum 94daf39b2f
Fix markup buglet in Doc/howto/annotations.rst (#29802) 2021-11-26 14:10:01 -08:00
Raymond Hettinger e34809e1c2
bpo-19072: Classmethod can wrap other classmethod like descriptors (GH-29634) 
staticmethod() also became callable in Python 3.10.

See: b83861f02.
 2021-11-19 19:43:49 +01:00
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.
Classmethods are useful when data stored in specific instances are *not*
needed.

Automerge-Triggered-By: GH:JulienPalard
 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 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
Brett Cannon 73224c4248 Merge 2016-12-22 10:02:16 -08:00
Brett Cannon 7e93c84438 Grammatical fixes following #d95f19892fd0 2016-12-22 10:02:01 -08:00
Brett Cannon ce042af3fe Merge for porting HOWTO update 2016-12-17 12:37:41 -08:00
Brett Cannon 5866719510 Update porting HOWTO to drop unicode_literals and mention static type checking 2016-12-17 12:37:20 -08:00
Martin Panter b7880b067b Issue #28820: Merge spelling fixes from 3.5 2016-12-10 05:38:25 +00:00
Martin Panter 898573a734 Issue #28820: Fix spelling of “practice” as a noun 2016-12-10 05:12:56 +00:00
Martin Panter 2fed8cd6f0 Issues #28755, #28753: Merge Arg Clinic howto from 3.5 2016-12-10 04:14:02 +00:00
Martin Panter cfa9bad4b2 Issue #28755: Improve syntax highlighting in Arg Clinic howto 2016-12-10 04:10:45 +00:00
Martin Panter a277c130f7 Issue 28753: Argument Clinic howto docfix, courtesy Julien Palard. 2016-12-10 03:49:12 +00:00
Serhiy Storchaka 29b0a26822 Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:20:55 +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
Serhiy Storchaka e418432dfb Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:22:09 +02: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
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
Berker Peksag 6b571e021a Issue #21590: Silence Sphinx warnings in instrumentation.rst 
WARNING: Could not lex literal_block as "c". Highlighting skipped.

Patch by SilentGhost.
 2016-11-06 21:45:16 +03:00
Serhiy Storchaka 0bbf8c08ab Issue #19795: Mark up True and False as literal text instead of bold. 2016-10-19 16:44:47 +03:00
Serhiy Storchaka a97cd2eb17 Issue #19795: Mark up True and False as literal text instead of bold. 2016-10-19 16:43:42 +03:00
Serhiy Storchaka 989db5c880 Issue #19795: Mark up None as literal text. 2016-10-19 16:37:13 +03:00
Serhiy Storchaka ecf41da83e Issue #19795: Mark up None as literal text. 2016-10-19 16:29:26 +03:00
Benjamin Peterson 8166a5db5b always use double quotes for SystemTap string literals (closes #28472) 
Patch by Roman Podoliaka.
 2016-10-18 23:33:03 -07:00
Berker Peksag 1cb7aaa9b1 Issue #27991: Merge from 3.5 2016-09-11 13:02:56 +03:00
Berker Peksag 53ba2d10e0 Issue #27991: Remove incorrect sentence about store_true 
Patch by py.user.
 2016-09-11 13:02:27 +03:00
Benjamin Peterson 699e2c91f6 reST is not markdown 2016-09-10 17:24:25 -07:00
Łukasz Langa a785c87d6e DTrace support: function calls, GC activity, line execution 
Tested on macOS 10.11 dtrace, Ubuntu 16.04 SystemTap, and libbcc.

Largely based by an initial patch by Jesús Cea Avión, with some
influence from Dave Malcolm's SystemTap patch and Nikhil Benesch's
unification patch.

Things deliberately left out for simplicity:
- ustack helpers, I have no way of testing them at this point since
they are Solaris-specific
- PyFrameObject * in function__entry/function__return, this is
SystemTap-specific
- SPARC support
- dynamic tracing
- sys module dtrace facility introspection

All of those might be added later.
 2016-09-09 17:37:37 -07:00
Benjamin Peterson cc854499e4 clinic: PY_LONG_LONG -> long long 2016-09-08 09:29:11 -07:00
R David Murray d44500cc29 Merge: #25916: fix a few 'string of bytes' references. 2016-08-23 20:44:31 -04:00