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

291 Commits

Author SHA1 Message Date
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
Serhiy Storchaka 148679982f Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:43:41 +03:00
Eric V. Smith b72e69e529 Fix grammar. 2014-01-25 05:11:43 -05:00
Serhiy Storchaka f47036c130 Removed spaces before colons and semicolons. 2013-12-24 11:04:36 +02:00
Serhiy Storchaka a4d170d985 Removed spaces before commas and periods. 2013-12-23 18:20:51 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
R David Murray 03b2a1ce51 #17623: fix whatsnew typo 
Patch by Thomas Heller.
 2013-04-03 06:16:14 -04:00
Georg Brandl 44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Chris Jerdonek 2654b86e88 Link to "yield from" examples in yield documentation. 
This commit also simplifies the more advanced "yield from" example and removes
unused function parameters.
 2012-12-23 15:31:57 -08:00
Ezio Melotti fa7aeecbca #16157: fix links in the whatsnew files. 2012-11-17 19:29:12 +02:00
Georg Brandl ff65a10418 Remove confusing "Release" and "Date" markers from whatsnews. Merge with 3.2. 2012-10-28 13:37:18 +01:00
Ezio Melotti 8cd45bd48d Fix PEP name. 2012-10-21 07:36:58 +03:00
Ezio Melotti 76e7ea5b4c Fix punctuation. 2012-10-20 22:53:47 +03:00
Ezio Melotti 36e01df18e Move note about the implementation in the "seealso". 2012-10-20 16:26:18 +03:00
R David Murray e54c718572 A couple more whatsnew updates. 2012-10-16 21:52:24 -04:00
Ezio Melotti ad626807a6 Fix typo. 2012-10-16 21:50:33 +03:00