82cd8fee31
Fix a typo in the contextlib documentation ( #114507 )
2024-01-24 05:16:31 +01:00
8c265408c5
Docs: use placeholders in dbm flag param docs ( #114482 )
...
Also correct the default flag param for dbm.dumb.open();
it's 'c', not 'r'.
2024-01-23 20:54:44 +01:00
01105c7c4f
Docs: mark up FTP.connect() and FTP.login() with param lists ( #114395 )
...
Use rst substitutions to reduce raw text duplication.
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-23 13:57:23 +00:00
5277d4c7db
Docs: mark up FTP.retrbinary and FTP.storbinary with param lists ( #114399 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 14:53:35 +01:00
7d21cae964
gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` ( #114425 )
...
* gh-101100: Fix sphinx warnings in `Doc/library/locale.rst`
* Remove `/` from signatures
2024-01-23 13:05:27 +02:00
b822b85ac1
GH-105900: Fix `pathlib.Path.symlink_to(target_is_directory=...)` docs ( #114035 )
...
Clarify that *target_is_directory* only matters if the target doesn't
exist.
2024-01-23 05:30:16 +00:00
32c227470a
GH-82695: Clarify `pathlib.Path.mkdir()` documentation ( #114032 )
...
Remove a double negative in the documentation of `mkdir()`'s *exist_ok*
parameter.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-23 02:31:09 +00:00
3a61d24062
GH-99334: Explain that `PurePath.is_relative_to()` is purely lexical. ( #114031 )
2024-01-23 01:06:44 +00:00
9af9ac153a
gh-66944: Note that the `contextlib.closing` example is for illustrative purposes ( #112198 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-23 01:00:53 +00:00
647b6cc7f1
Docs: minor amendments to runpy.rst ( #18416 )
...
- Add missing single quote in inline code
- Align parameter formatting with style guide recommendations
- Fix punctuation around parenthesised sentence
2024-01-23 00:00:26 +00:00
1d7bddd961
Docs: align usage of versionadded/versionchanged with recommended practice ( #114409 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-22 21:40:26 +00:00
8ccd1ba461
gh-101100: Fix Sphinx warnings in `reference/expressions.rst` ( #114194 )
2024-01-22 18:21:14 +02:00
1b719b39b9
gh-114321: Expose more constants in the fcntl module (GH-114322)
2024-01-22 18:09:22 +02:00
6d30cbee01
Docs: Fix typo in code snippet (GH-114421)
2024-01-22 17:56:30 +02:00
650f9e4c94
gh-114115: Update documentation of array.array (GH-114117)
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 08:42:50 +00:00
fd49e22670
gh-114328: tty cbreak mode should not alter ICRNL ( #114335 )
...
The terminal CR -> NL mapping setting should be inherited in cbreak mode as OSes do not specify altering it as part of their stty cbreak mode definition.
2024-01-21 15:25:52 -08:00
336030161a
Docs: align sqlite3 docs with versionadded/versionchanged recommendations ( #114400 )
...
When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
2024-01-21 19:54:19 +00:00
de17cf444a
Docs: link to sys.stdout in ftplib docs ( #114396 )
2024-01-21 17:41:21 +00:00
38768e4cdd
gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect implementation ( #114385 )
2024-01-21 13:49:49 +01:00
96c15b1c8d
Docs: mark up FTP() constructor with param list ( #114359 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 12:27:33 +01:00
47133d8d86
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` ( #114373 )
2024-01-21 11:34:43 +02:00
fbc28748ea
Docs: mark up the FTP debug levels as a list ( #114360 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 09:19:31 +00:00
b04c5005cc
Fix the confusing "User-defined methods" reference in the datamodel ( #114276 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-21 03:45:38 +00:00
8f4f773647
Docs: Add missing line continuation to FTP_TLS class docs ( #114352 )
...
Regression introduced by b1ad5a5d4
2024-01-20 19:39:44 +00:00
b1ad5a5d44
Docs: structure the ftplib reference ( #114317 )
...
Introduce the following headings and subheadings:
- Reference
* FTP objects
* FTP_TLS objects
* Module variables
2024-01-20 16:06:52 +01:00
e6495159f6
GH-99380: Update to Sphinx 7 ( #99381 )
2024-01-20 11:20:51 +00:00
567a85e9c1
gh-114332: Fix the flags reference for ``re.compile()`` ( #114334 )
...
The GH-93000 change set inadvertently caused a sentence in re.compile()
documentation to refer to details that no longer followed. Correct this
with a link to the Flags sub-subsection.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-20 11:17:41 +00:00
6313cdde58
GH-79634: Accept path-like objects as pathlib glob patterns. ( #114017 )
...
Allow `os.PathLike` objects to be passed as patterns to `pathlib.Path.glob()` and `rglob()`. (It's already possible to use them in `PurePath.match()`)
While we're in the area:
- Allow empty glob patterns in `PathBase` (but not `Path`)
- Speed up globbing in `PathBase` by generating paths with trailing slashes only as a final step, rather than for every intermediate directory.
- Simplify and speed up handling of rare patterns involving both `**` and `..` segments.
2024-01-20 02:10:25 +00:00
229ee5bea1
Retain shorter tables of contents for Sphinx 5.2.3+ ( #114318 )
...
Disable toc_object_entries, new in Sphinx 5.2.3
2024-01-19 18:52:42 +00:00
68a7b78cd5
gh-112092: clarify unstable ABI recompilation requirements ( #112093 )
...
Use different versions in the examples for when extensions do and do not need to be recompiled to make the examples easier to understand.
2024-01-18 21:04:40 +01:00
9c93350f58
gh-108303: Move all doctest related files and tests to `Lib/test/test_doctest/` ( #112109 )
...
Co-authored-by: Brett Cannon <brett@python.org>
2024-01-18 16:58:11 +01:00
ba683c22ec
gh-114231: Fix indentation in enum.rst ( #114232 )
2024-01-18 09:23:15 +00:00
8cda72037b
gh-114211: Update EmailMessage doc about ordered keys ( #114224 )
...
Ordered keys are no longer unlike 'real dict's.
2024-01-18 02:25:22 +00:00
f56d132deb
gh-112984 Update Windows build and installer for free-threaded builds (GH-113129)
2024-01-17 21:52:23 +00:00
7573c44c32
Fix typo in tkinter.ttk.rst (GH-106157)
2024-01-17 18:23:25 +00:00
029ecee10d
gh-114070: fix token reference warnings in expressions.rst ( #114169 )
2024-01-17 18:39:50 +02:00
f49752552e
gh-111301: Advertise importlib methods removal in What's new in Python 3.12 (GH-111630)
2024-01-17 15:25:42 +01:00
4a32275389
gh-72284: Revise lists in IDLE doc ( #114174 )
...
Tkinter is a fact, not necessarily a feature.
Reorganize editor key bindings in a logical order
and remove those that do not work, at least on Windows.
Improve shell bindings list.
2024-01-17 07:52:32 +00:00
8d26db45df
gh-112043: Align concurrent.futures.Executor.map docs with implementation ( #114153 )
...
The first parameter is named 'fn', not 'func'.
2024-01-17 01:31:16 +00:00
05008c27b7
gh-88531 Fix dataclass __post_init__/__init__ interplay documentation (gh-107404)
...
* Simplify __post_init__ example usage. It applies to all base classes, not just dataclasses.
2024-01-16 20:17:34 -05:00
45e527dfb5
GH-110109: pathlib docs: bring `from_uri()` and `as_uri()` together. ( #110312 )
...
This is a very soft deprecation of `PurePath.as_uri()`. We instead document
it as a `Path` method, and add a couple of sentences mentioning that it's
also available in `PurePath`.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-16 22:51:57 +00:00
1d6989f9b0
Fix typo in c_annotations.py comment ( #108773 )
...
"compatability" => "compatibility"
2024-01-16 23:36:01 +01:00
6e84f3b56f
gh-94220: Align fnmatch docs with the implementation and amend markup ( #114152 )
...
- Align the argument spec for fnmatch functions with the actual
implementation.
- Update Sphinx markup to recent recommandations.
- Add link to 'iterable' glossary entry.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-16 22:35:09 +00:00
7092b3f131
GH-78988: Document `pathlib.Path.glob()` exception propagation. ( #114036 )
...
We propagate the `OSError` from the `is_dir()` call on the top-level
directory, and suppress all others.
2024-01-16 22:28:54 +00:00
c86571e4c9
Update copyright years to 2024. (GH-113608)
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-16 21:54:05 +01:00
b1db6278cf
Docs: Improve multiprocessing.SharedMemory reference ( #114093 )
...
Align the multiprocessing shared memory docs with Diatáxis's
recommendations for references.
- use a parameter list for the SharedMemory.__init__() argument spec
- use the imperative mode
- use versionadded, not versionchanged, for added parameters
- reflow touched lines according to SemBr
2024-01-16 16:43:13 +00:00
31a2543c80
gh-114069: Revise Tutorial Methods paragraph ( #114127 )
...
Remove excess words in the first and third sentences.
2024-01-16 11:33:05 -05:00
d2d8332f71
gh-113626: Add allow_code parameter in marshal functions (GH-113648)
...
Passing allow_code=False prevents serialization and de-serialization of
code objects which is incompatible between Python versions.
2024-01-16 18:05:15 +02:00
a482bc67ee
gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557)
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-01-16 16:17:03 +01:00
af85274086
Docs: Align multiprocessing.shared_memory docs with Sphinx recommendations ( #114103 )
...
- add :class: and :mod: markups where needed
- fix incorrect escaping of a star in ShareableList arg spec
- mark up parameters with stars: *val*
- mark up list of built-in types using list markup
- remove unneeded parentheses from :meth: markups
2024-01-16 12:35:35 +00:00
Daniel Hollas
Erlend E. Aasland
Nikita Sobolev
Barney Gale
Ville Skyttä
Géry Ogam
Hugo van Kemenade
Serhiy Storchaka
Kirill Podoprigora
Gregory P. Smith
cdzhan
Adam Turner
David H. Gutteridge
DerSchinken
Miyashita Yosuke
Terry Jan Reedy
Steve Dower
Christophe Nanteuil
Sergey B Kirpichev
Karolina Surma
Steffen Zeile
Kuan-Wei Chiu
solya0x
AN Long