summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
...
* bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010)Raymond Hettinger2019-09-121-1/+1
|
* Doc: Add -m reference in context of code execution (GH-16045)Julien Palard2019-09-121-1/+3
|
* bpo-37363: Document internal audit events (GH-14663)Christian Heimes2019-09-121-1/+6
| | | | | | | | | Three internal cpython events were not documented, yet. Signed-off-by: Christian Heimes <christian@python.org> https://bugs.python.org/issue37363
* bpo-36373: Deprecate explicit loop in task and subprocess API (GH-16033)Andrew Svetlov2019-09-122-10/+31
|
* bpo-26868: Fix example usage of PyModule_AddObject. (#15725)Brandt Bucher2019-09-128-13/+73
| | | | | | | | | | | | | | | | * Add a note to the PyModule_AddObject docs. * Correct example usages of PyModule_AddObject. * Whitespace. * Clean up wording. * 📜🤖 Added by blurb_it. * First code review. * Add < 0 in the tests with PyModule_AddObject
* bpo-35325: Doc: imp.find_module() return value documentation discrepancy ↵Windson yang2019-09-121-6/+5
| | | | | | (GH-11040)
* bpo-35685: Add examples of unittest.mock.patch.dict usage (GH-11456)Emmanuel Arias2019-09-121-4/+27
|
* bpo-36675: Remove obsolete code. (GH-16024)Julien Palard2019-09-122-34/+0
| | | | Does no longer work since Sphinx moved the trim_doctest_flag option in the configuration.
* bpo-32008: Prefer client or TLSv1_2 in examples (GH-5797)Christian Heimes2019-09-121-8/+14
| | | | | Prefer client or TLSv1_2 in examples Signed-off-by: Christian Heimes <christian@python.org>
* bpo-9938: Add optional keyword argument exit_on_error to ↵Hai Shi2019-09-121-1/+29
| | | | | | | | | | | | argparse.ArgumentParser (GH-15362) Co-Authored-by: Xuanji Li <xuanji@gmail.com> https://bugs.python.org/issue9938 Automerge-Triggered-By: @matrixise
* bpo-13927: time.ctime and time.asctime return string explantion (GH-11303)Harmandeep Singh2019-09-121-7/+15
| | | | | | | | * bpo-13927: time.ctime and time.asctime return string explantion * Add note explaining that time.ctime and time.asctime returns a space padded date value in case it contains a single digit date * Reformat linebreaks
* Doc: Add example of dict() function with positional and keyword arguments ↵Georgy Frolov2019-09-121-1/+2
| | | | (GH-15220)
* bpo-18578: Rename and document test.bytecode_helper as ↵Joannah Nanjekye2019-09-121-0/+30
| | | | | test.support.bytecode_helper (GH-15168) Rename and document test.bytecode_helper as test.support.bytecode_helper
* Correct typos in the codecs module documentation (#15135)Géry Ogam2019-09-121-60/+61
|
* bpo-36270: Doc: add link to traceback object reference (GH-13119)Björn Meier2019-09-111-1/+1
|
* bpo-37698: Update doc of PyBuffer_ToContiguous (GH-14992)Hai Shi2019-09-111-2/+2
| | | https://bugs.python.org/issue37698
* Doc: recursive glob ** follows symlinks to directories (GH-12918)Marc2019-09-111-2/+3
|
* bpo-28724: Add methods send_fds and recv_fds to the socket module (GH-12889)Joannah Nanjekye2019-09-112-0/+23
| | | | | | | The socket module now has the socket.send_fds() and socket.recv.fds() functions. Contributed by Joannah Nanjekye, Shinya Okano (original patch) and Victor Stinner. Co-Authored-By: Victor Stinner <vstinner@redhat.com>
* bpo-37750: Add doc of PyBuffer_FromContiguous (GH-15988)Hai Shi2019-09-111-0/+7
| | | | | | | https://bugs.python.org/issue37750 Automerge-Triggered-By: @matrixise
* Doc: Fix missing negation. (GH-14640)Julien Palard2019-09-111-2/+2
| | | | | | | Reported by Hug Capella on docs@. Automerge-Triggered-By: @matrixise
* Improve clarity of try-return-finally-return (GH-15677)toonarmycaptain2019-09-111-9/+22
| | | Clarify execution in try-return-finally-return case.
* bpo-36182: Update pathlib.Path.write_text() docs (GH-12161)Lysandros Nikolaou2019-09-111-0/+3
| | | with the case of an existing file
* bpo-36260: Add pitfalls to zipfile module documentation (#13378)JunWei Song2019-09-111-0/+40
| | | | | | | | | | | | | | | | * bpo-36260: Add pitfalls to zipfile module documentation We saw vulnerability warning description (including zip bomb) in Doc/library/xml.rst file. This gave us the idea of documentation improvement. So, we moved a little bit forward :P And the doc patch can be found (pr). * fix trailing whitespace * 📜🤖 Added by blurb_it. * Reformat text for consistency.
* Improve the io module documentation (GH-15099)Géry Ogam2019-09-111-55/+61
| | | | | | | | | | * Update io.rst * Apply suggestions from code review Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com> Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
* bpo-35224: Additional documentation for Assignment Expressions (GH-15935)Emily Morehouse2019-09-114-60/+9
| | | | | | | | | | | | | Add or update assignment expression documentation for: - FAQ - Design - Reference - Expressions - Reference - Lexical Analysis https://bugs.python.org/issue35224 Automerge-Triggered-By: @matrixise
* Doc: Indicate locations of parse_qs, parse_qsl, escape (GH-14828)Simon Willison2019-09-111-1/+2
| | | | Since they have been removed from cgi it's useful to remind people where they can be found instead.
* Update ftplib.all_errors documentation to match code (#15026)Andrew Scheller2019-09-111-1/+1
| | | The documentation doesn't mention the `EOFError` that https://github.com/python/cpython/blob/master/Lib/ftplib.py#L66 includes
* bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895)Raymond Hettinger2019-09-114-28/+31
| | | | | | | | * bpo-38096: Clean up the "struct sequence" / "named tuple" docs * Fix remaining occurrences of "struct sequence" * Repair a user visible docstring
* bpo-37651: Document CancelledError is now a subclass of BaseException (GH-15950)Xtreak2019-09-111-19/+2
| | | | | | | https://bugs.python.org/issue37651 Automerge-Triggered-By: @1st1
* bpo-33187: Document ElementInclude (XInclude) support in ElementTree (GH-8861)Anjali Bansal2019-09-112-0/+92
|
* bpo-23460: Fix documentation for decimal string :g formatting (GH-11850)Brennan D Baraban2019-09-111-3/+4
|
* bpo-37488 : Document a warning for datetime.utcnow() and utcfromtimestamp() ↵Joannah Nanjekye2019-09-111-16/+34
| | | | | | | | | (GH-15773) https://bugs.python.org/issue37488 Automerge-Triggered-By: @pganssle
* bpo-31163: Added return values to pathlib.Path instance's rename and replace ↵hui shang2019-09-111-5/+14
| | | | | methods. (GH-13582) * bpo-31163: Added return values to pathlib.Path instance's rename and replace methods.
* bpo-33944: note about the intended use of code in .pth files (GH-10131)native-api2019-09-111-0/+13
| | | https://bugs.python.org/issue33944
* bpo-33459: Fix "tuple displays" term in Expressions.rst (GH-6760)Andre Delfino2019-09-111-4/+4
| | | | | | | https://bugs.python.org/issue33459 Automerge-Triggered-By: @matrixise
* bpo-35640: Allow passing PathLike arguments to SimpleHTTPRequestHandler ↵Géry Ogam2019-09-111-0/+3
| | | | (GH-11398)
* Doc: Use walrus operator in example. (GH-15934)Julien Palard2019-09-111-4/+1
|
* bpo-35649: update http client example (GH-11441)Ashwin Ramaswami2019-09-111-2/+5
|
* Minor ReST formatting fixes in subprocess docs (#14876)Tim Hoffmann2019-09-111-4/+4
|
* bpo-35603: Add a note on difflib table header interpreted as HTML (GH-11439)Xtreak2019-09-111-0/+4
|
* bpo-35168: Make shlex.punctuation_chars read-only (#11631)Alex2019-09-111-3/+5
| | | | | | | | * bpo-35168: Documentation about shlex.punctuation_chars now states that it should be set in __init__.py * bpo-35168: Convert shlex.punctuation_chars to read-only property * Add NEWS.d entry
* bpo-32972: Document IsolatedAsyncioTestCase of unittest module (GH-15878)Xtreak2019-09-112-0/+102
| | | | | | | | | | | * Document `unittest.IsolatedAsyncioTestCase` API * Add a simple example with respect to order of evaluation of setup and teardown calls. https://bugs.python.org/issue32972 Automerge-Triggered-By: @asvetlov
* bpo-38103: fix conflicting labels in the docs. (GH-15906)Ezio Melotti2019-09-112-5/+5
|
* bpo-25810: Clarify eval() docs, it does not keywords (GH-15173)smokephil2019-09-111-1/+1
|
* bpo-37585: Add clarification regarding comparing dict.values() (GH-14954)Kyle Stanley2019-09-111-0/+8
|
* bpo-16438: Doc: confusing text regarding numeric precedence corrected (GH-10521)Anjali2019-09-111-3/+2
|
* Overhaul datetime documentation (GH-13410)Brad2019-09-111-476/+729
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a restructuring of the datetime documentation to hopefully make them more user-friendly and approachable to new users without losing any of the detail. Changes include: - Creating dedicated subsections for some concepts such as: - "Constants" - "Naive vs Aware" - "Determining if an Object is Aware" - Give 'naive vs aware' its own subsection - Give 'constants' their own subsection - Overhauling the strftime-strptime section by: - Breaking it into logical, linkable, and digestable parts - Adding a high-level comparison table - Moving the technical detail to bottom: readers come to this section primarily to remind themselves to things: - How do I write the format code for X? - strptime/strftime: which one is which again? - Touching up fromisoformat + isoformat sections by: - Revising fromisoformat + isoformat for date, time, and datetime - Adding basic examples - Enforcing consistency about putting formats (i.e. ``HH:MM``) in double backticks. This was previously done in some places but not all - Putting long 'supported formats', on their own line to improve readability - Moving the 'seealso' section to the top and add a link to dateutil Rationale: This doesn't really belong nested under the 'constants' section. Let readers know right away that datetime is one of several related tools. - Moving common features of several types into one place: Previously, each type went out of its way to note separately that it was hashable and picklable. These can be brought into one single place that is more prominent. - Reducing some verbose explanations to improve readability - Breaking up long paragraphs into digestable chunks - Displaying longer "equivalent to" examples, as short code blocks - Using the dot notation for datetime/time classes: Use :class:`.time` and :class:`.datetime` rather than :class:`time` and :class:`datetime`; otherwise, the generated links will route to the respective modules, not classes. - Rewording the tzinfo class description The top paragraph should get straight to the point of telling the reader what subclasses of tzinfo _do_. Previously, that was hidden in a later paragraph. - Adding a note on .today() versus .now() - Rearranging and expanding example blocks, including: - Moved long, multiline inline examples to standalone examples - Simplified the example block for timedelta arithmetic: - Broke the example into two logical sections: 1. normalization/parameter 'merging' 2. timedelta arithmetic - Reduced the complexity of the some of the examples. Show reasonable, real-world uses cases that are easy to follow along with and progres in difficult slightly. - Broke up the example sections for date and datetime sections by putting the easy examples first, progressing to more esoteric situations and breaking it up into logical sections based on what the methods are doing at a high level. - Simplified the KabulTz example: - Put the class definition itself into a non-REPL block since there is no interactive output involved there - Briefly explained what's happening before launching into the code - Broke the example section into visually separate chunks - Various whitespace, formatting, style and grammar fixes including: - Consistently using backctics for 'date_string' formats - Consistently using one space after periods. - Consistently using bold for vocab terms - Consistently using italics when referring to params: See https://devguide.python.org/documenting/#id4 - Using '::' to lead into code blocks Per https://devguide.python.org/documenting/#source-code, this will let the reader use the 'expand/collapse' top-right button for REPL blocks to hide or show the prompt. - Using consistent captialization schemes - Removing use of the default role - Put 'example' blocks in Markdown subsections This is a combination of 66 commits. See bpo-36960: https://bugs.python.org/issue36960
* bpo-38034: Fix typo in logging.handlers.rst (GH-15708)wwuck2019-09-111-1/+1
|
* bpo-37574: Mention helper functions for find_spec documentation (GH-14739)jdkandersson2019-09-101-1/+4
|
* bpo-33602: Doc: Remove set and queue references from Data Types (GH-7055)Andre Delfino2019-09-101-3/+4
|
generated by cgit v0.12 at 2025-04-11 11:11:36 (GMT)