Ezio Melotti
3dd593e2f2
gh-110631: fix wrong indentation in the `Doc/whatsnew` dir ( #110632 )
...
Fix wrong indentation in the Doc/whatsnew dir.
2023-10-11 07:34:38 +02:00
Serhiy Storchaka
92af0cc580
gh-109634: Use :samp: role (GH-109635)
2023-09-23 09:31:20 +03: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
db55383829
gh-107298: Fix references to deprecated and removed PyUnicode C API (GH-108077)
2023-08-21 20:05:15 +03:00
Serhiy Storchaka
0aa58fa7a6
gh-107091: Fix some uses of :const: role (GH-107379)
...
It is for references, not for literals.
2023-07-28 13:26:28 +03:00
Serhiy Storchaka
6d5b6e71c8
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +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
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
Serhiy Storchaka
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
Victor Stinner
e4127eaa1e
gh-104773: PEP 594: Remove the crypt module ( #104908 )
...
Remove the crypt module and its private _crypt extension, deprecated
in Python 3.11.
2023-05-25 15:45:46 +02:00
Victor Stinner
ded5f1f287
gh-104773: PEP 594: Remove the nntplib module ( #104894 )
...
* socket_helper.transient_internet() no longer imports nntplib to
catch nntplib.NNTPTemporaryError.
* ssltests.py no longer runs test_nntplib.
* "make quicktest" no longer runs test_nntplib.
* WASM: remove nntplib from OMIT_NETWORKING_FILES.
* Remove mentions to nntplib in the email documentation.
2023-05-24 21:15:43 +00:00
Victor Stinner
a4b7e9d1f8
gh-104773: PEP 594: Remove the pipes module ( #104848 )
2023-05-24 13:11:29 +02:00
Adam Turner
328435ed42
GH-98040: Suppress cross-references to the removed ``imp`` module ( #104131 )
...
Suppress cross-references to imp
2023-05-03 13:29:42 +01:00
Barry Warsaw
326997829d
gh-98040: Remove find_loader, find_module and other deprecated APIs ( #98059 )
...
* Remove deprecated classes from pkgutil
* Remove some other PEP 302 obsolescence
* Use find_spec instead of load_module
* Remove more tests of PEP 302 obsolete APIs
* Remove another bunch of tests using obsolete load_modules()
* Remove deleted names from __all__
* Remove obsolete footnote
* imp is removed
* Remove `imp` from generated stdlib names
* What's new and blurb
* Update zipimport documentation for the removed methods
* Fix some Windows tests
* Remove any test (or part of a test) that references `find_module()`.
* Use assertIsNone() / assertIsNotNone() consistently.
* Update Doc/reference/import.rst
* We don't need pkgutil._get_spec() any more either
* test.test_importlib.fixtures.NullFinder
* ...BadLoaderFinder.find_module
* ...test_api.InvalidatingNullFinder.find_module
* ...test.test_zipimport test of z.find_module
* Suppress cross-references to find_loader and find_module
* Suppress cross-references to Finder
* Suppress cross-references to pkgutil.ImpImporter and pkgutil.ImpLoader
---------
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-05-03 04:55:22 -07: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
Stanley
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08: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
Adam Turner
0031e62973
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) ( #97768 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-05 11:01:14 -07:00
Adam Turner
a081cae2a2
gh-93738: Documentation C syntax (:c:type:`Py_UNICODE*` -> :c:expr:`Py_UNICODE*`) ( #97784 )
...
:c:type:`Py_UNICODE*` -> :c:expr:`Py_UNICODE*`
2022-10-04 16:10:57 -07:00
Will Hawkins
bd7d0e875e
Fix capitalization of Unix in documentation ( #96913 )
2022-10-01 16:41:06 -07: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
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
Victor Stinner
474652fe93
bpo-40204, doc: Fix syntax of C variables (GH-21846)
...
For example, fix the following Sphinx 3 errors:
Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 5]
void \*obj
-----^
Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*'
Invalid C declaration: Expected end of definition. [error at 8]
PyObject*
--------^
The modified documentation is compatible with Sphinx 2 and Sphinx 3.
2020-08-13 22:11:50 +02:00
Raymond Hettinger
7117074410
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895)
...
* bpo-38096: Clean up the "struct sequence" / "named tuple" docs
* Fix remaining occurrences of "struct sequence"
* Repair a user visible docstring
2019-09-11 15:17:32 +01: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
Stéphane Wirtel
683281f536
bpo-34906: Doc: Fix typos (2) (GH-9735)
...
Fix typos
2018-10-06 16:35:53 +02:00
Xtreak
c151f7846d
bpo-33859: Fix spelling mistakes in docs. (GH-7691)
2018-06-16 08:08:31 +03:00
Serhiy Storchaka
5bb0005f9f
Make formatting of some return codes conforming to the general style. ( #5587 )
2018-02-09 13:31:19 +02:00
luzpaz
a5293b4ff2
Fix miscellaneous typos ( #4275 )
2017-11-05 15:37:50 +02:00
Serhiy Storchaka
7d6dda4b78
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:36:51 +03:00
Serhiy Storchaka
4adf01caae
Issue #19795 : Improved more markups of True/False.
2016-10-19 18:30:05 +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
Martin Panter
0be894b2f6
Issue #27895 : Spelling fixes (Contributed by Ville Skyttä).
2016-09-07 12:03:06 +00:00
Raymond Hettinger
15f44ab043
Issue #27895 : Spelling fixes (Contributed by Ville Skyttä).
2016-08-30 10:47:49 -07:00
Martin Panter
6a09315ff0
Issue #26462 : Merge code block fixes from 3.5
2016-07-29 01:49:37 +00: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
Ned Deily
538f5c4786
Issue #27285 : Cleanup "suspicious" warnings.
2016-07-11 14:21:58 -04:00
Serhiy Storchaka
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +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
Serhiy Storchaka
d65c9496da
Issue #25523 : Further a-to-an corrections.
2015-11-02 14:10:23 +02:00
Martin Panter
7462b64911
Issue #25523 : Correct "a" article to "an" article
...
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Senthil Kumaran
b4760efbad
Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
...
Related Issues:
#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
Serhiy Storchaka
d3faf43f9b
Issue #23181 : More "codepoint" -> "code point".
2015-01-18 11:28:37 +02:00
Serhiy Storchaka
56a6d855e2
Removed duplicated words in in comments and docs.
2014-12-01 18:28:43 +02:00
Serhiy Storchaka
e5cf4868d3
Issue #22388 : Unified the style of "Contributed by" sentences in What's New.
2014-11-02 19:18:52 +02:00
Georg Brandl
6b4c847c4f
Doc: fix default role usage (except in unittest mock docs)
2014-10-30 22:26:26 +01:00
Georg Brandl
b7354a65ce
Fixing broken links in doc, part 4: some more breaks and redirects
2014-10-29 10:57:37 +01:00
Georg Brandl
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00