Alex Waygood
3024b16d51
gh-101100: Consolidate documentation on `ModuleType` attributes ( #124709 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Barry Warsaw <barry@python.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-10-09 10:53:57 +00:00
Alex Waygood
0d9d56c4e4
gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs ( #124480 )
2024-09-25 19:29:58 +00:00
Wei-Hsiang (Matt) Wang
cf472577e2
gh-123517: Remove unnecessary ``:meth:`` parentheses ( #123518 )
2024-09-01 05:59:42 +01:00
Hugo van Kemenade
006b53a42f
NEWS: Fix Sphinx warnings and increase threshold for new news nits ( #121482 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-07-08 14:30:05 -06:00
Hugo van Kemenade
3375282bb8
Docs: add link roles with Sphinx extlinks ( #117850 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
Hugo van Kemenade
848c86786b
gh-101100: Fix Sphinx warnings from PEP 3108 stdlib re-organisation ( #114327 )
...
* Fix Sphinx warnings from PEP 3108 stdblib re-organisation
* Apply suggestions from code review
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Update Doc/whatsnew/2.2.rst
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Apply suggestions from code review
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
---------
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-04 09:45:35 +00:00
Hugo van Kemenade
fab7ad62ce
gh-101100: Fix Sphinx warnings for removed dead batteries ( #113669 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-03 13:04:26 +00:00
Hugo van Kemenade
7595380347
gh-101100: Fix Sphinx warnings from removed `~!` references ( #113629 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-02 00:37:37 -07:00
Alex Waygood
96f64a2b1b
gh-101100: Improve documentation of `TracebackType` attributes ( #112884 )
2023-12-09 22:43:53 +00:00
Heinz-Alexander Fuetterer
ef6d475db3
Fix typos in docs and comments ( #109619 )
2023-09-20 16:58:23 +00:00
Serhiy Storchaka
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
Serhiy Storchaka
af61cb9c78
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
Serhiy Storchaka
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
2023-07-22 21:35:22 +03:00
Serhiy Storchaka
26e08dfdd7
gh-107008: Document the curses module variables LINES and COLS (GH-107011)
...
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
2023-07-22 19:54:50 +03:00
Serhiy Storchaka
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
Victor Stinner
e399f46a77
gh-104773: PEP 594: Remove the imghdr module ( #104777 )
...
* Remove the Lib/test/imghdrdata/ directory.
* Copy 5 pictures (gif, png, ppm, pgm, xbm) from removed
Lib/test/imghdrdata/ to a new Lib/test/tkinterdata/ directory.
* Update Sphinx from 4.5 to 6.2 in Doc/requirements.txt.
2023-05-26 13:29:45 +00:00
Victor Stinner
fc07fe4e37
gh-104773: PEP 594: Remove the ossaudiodev module ( #104862 )
...
* Remove ossaudiodev extension in configure.ac and regenerate
the configure script.
* Remove ossaudiodev in Modules/Setup and Modules/Setup.stdlib.in.
2023-05-24 15:00:51 +02:00
Rafael Fontenelle
68ed2a2a3f
GH-103484: Fix redirected permanently URLs ( #104001 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
2023-05-02 09:34:44 +03:00
Hugo van Kemenade
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
Serhiy Storchaka
dd53b79de0
gh-96959: Update more HTTP links (GH-97536)
...
Use HTTPS for documents which are available by both HTTP and HTTPS
links, but there is no redirection from HTTP to HTTPS or vice versa.
2022-09-27 14:08:11 +03:00
Serhiy Storchaka
f79547a429
gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527)
...
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.
This change does not affect Python examples.
2022-08-04 10:13:49 +03:00
Oleg Iarygin
d58be48369
gh-85454: Remove links from historical mentions of distutils (GH-95192)
2022-07-25 12:20:09 +02:00
Victor Stinner
bb0b08540c
bpo-40204: Fix reference to terms in the doc (GH-21865)
...
Sphinx 3 requires to refer to terms with the exact case.
For example, fix the Sphinx 3 warning:
Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case
sensitive match.made a reference to loader instead.
2020-08-14 12:20:05 +02:00
Stéphane Wirtel
e483f02423
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
2018-10-26 12:52:11 +02:00
Stéphane Wirtel
683281f536
bpo-34906: Doc: Fix typos (2) (GH-9735)
...
Fix typos
2018-10-06 16:35:53 +02:00
Yury Selivanov
7c7605ff11
bpo-33649: First asyncio docs improvement pass (GH-9142)
...
Rewritten/updated sections:
* Event Loop APIs
* Transports & Protocols
* Streams
* Exceptions
* Policies
* Queues
* Subprocesses
* Platforms
2018-09-11 09:54:40 -07:00
Ned Deily
9d6171ded5
bpo-23404: Update/sync What's New files for 3.6/3.5/2.7 (GH-7620)
2018-06-11 04:09:34 -04: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
Matthias Bussonnier
0899b98095
bpo-28814: Undeprecate inadvertently deprecated inspect functions. ( #122 )
...
Nick Coghlan said on bpo-28814:
> inspect.getargvalues() and inspect.formatargvalues() were deprecated
> in Python 3.5 as part of implementing bpo-20438
> This is incorrect, as these are *frame* introspection related functions,
> not callable introspection ones. The documentation and implementation
> layout is confusing though, as they're interleaved with the callable
> introspection operation
This commit undeprecates these functions and adds a note to ignore
previous deprecation notices.
2017-02-22 08:45:51 +03: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
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
Martin Panter
f8c25e3424
Issue #28678 : Merge parameter name from 3.5 into 3.6
2016-11-13 23:36:07 +00:00
Martin Panter
efbf20f3a3
Issue #28678 : Fix references to numeric_owner parameter
2016-11-13 23:25:06 +00:00
Steve Dower
fb4a96a58f
Issue #28251 : Improvements to help manuals on Windows.
2016-09-22 17:07:56 -07:00
Serhiy Storchaka
9fab79bcb5
Issue #26900 : Excluded underscored names and other private API from limited API.
2016-09-11 11:03:14 +03:00
Benjamin Peterson
c1db513e36
repair errors in (set|get)_task_factory note ( #28051 )
2016-09-09 12:46:42 -07:00
Martin Panter
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Benjamin Peterson
909acb8c63
alter header; '%' really throws latex through a loop
2016-06-21 23:47:16 -07:00
Martin Panter
0c0da48aed
Issue #24136 : Document generalized unpacking, PEP 448
...
Based on patches by Konstantin Molchanov and Neil Girdhar.
2016-06-12 01:46:50 +00:00
Yury Selivanov
a6f6edbda8
Issue #27243 : Fix __aiter__ protocol
2016-06-09 15:08:31 -04:00
Yury Selivanov
c1cf296de6
asyncio: Remove asyncio.timeout() context manager.
...
It will probably be added back in Python 3.6, once its compatibility
issues are resolved; see [1] for more details.
[1] https://mail.python.org/pipermail/async-sig/2016-June/000045.html
2016-06-08 13:57:03 -04:00
Yury Selivanov
af74512e44
asyncio: Update whatsnew/3.5.2
2016-06-08 12:55:29 -04:00
Martin Panter
a90a4a9651
Issue #27125 : Remove duplicated words from documentation and comments
2016-05-30 04:04:50 +00:00
Yury Selivanov
950204df9c
docs: Update asyncio docs & whatsnew
2016-05-16 16:23:00 -04:00
Berker Peksag
8d8221f0d6
Issue #26041 : Remove "will be removed in Python 3.7" from description messages
...
We will keep platform.dist() and platform.linux_distribution() to make porting
from Python 2 easier.
Patch by Kumaripaba Miyurusara Athukorala.
2016-04-24 03:32:24 +03:00
Georg Brandl
5d94134040
Closes #25910 : fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch.
2016-02-26 19:37:12 +01:00
Martin Panter
c04fb56e36
Issue #26304 : Change "allows to <verb>" to "allows <verb>ing" or similar
...
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Martin Panter
96a4f07107
Issues #26310 , #26311 : Fix typos in the documentation and code comments
2016-02-10 01:17:51 +00:00
Yury Selivanov
4a18b35dbd
docs/whatsnew/3.5: Fix ref link
2015-12-15 00:38:28 -05:00
Yury Selivanov
bf077ee043
whatsnew/3.5: Mention new asyncio APIs in 3.5.1
2015-12-15 00:30:18 -05:00