Commit Graph

71 Commits

Author SHA1 Message Date
Rafael Fontenelle 0a32c6959c
GH-103484: Fix permanently redirects reported by linkcheck (GH-124144)
Fix redirects reported by linkcheck, update docs conf.py checks.
2024-09-17 02:53:38 +00:00
Serhiy Storchaka 1a0c7b9ba4
gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
Terry Jan Reedy 43986f5567
gh-111307: Update design FAQ 'switch' entry (#115899) 2024-03-13 01:30:39 -04:00
Serhiy Storchaka a8629816c6
gh-113664: Improve style of Big O notation (GH-113695)
Use cursive to make it looking like mathematic formulas.
2024-01-10 15:01:18 +02:00
Adam Turner 92815cc7cf
Resolve reference warnings in faq/design.rst (#108148) 2023-08-20 12:34:27 -06:00
Jelle Zijlstra 0f111f53c1
gh-96073: fix backticks in NEWS entry (GH-98056)
Automerge-Triggered-By: GH:JelleZijlstra
2022-10-07 14:44:56 -07:00
Stanley 3a7e955858
gh-96265: Fix some formatting in faq/design.rst (#96924)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-07 12:15:41 -07: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
Stanley e5ab0b6aa6
gh-71141: Add note on rejecting "leading-dot" syntax for with statements (#96928)
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
2022-09-20 21:16:39 -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
Carl Bordum Hansen bb900712a5
Remove VOC reference (93333)
VOC has been archived by the BeeWare project, and they are instead
embedding CPython, rather than transpiling to Java bytecode.
2022-05-31 10:29:21 -07:00
Nikita Sobolev b9d8980d89
bpo-43698: do not use `...` as argument name in docs (GH-30502) 2022-01-26 19:06:10 +09:00
Christian Clauss 241bda785a
[doc] Fix typos found using codespell (GH-28744)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-05 23:48:44 +02:00
Terry Jan Reedy 51f45d085d
bpo-13814: Explain why generators are not context managers (GH-26835)
Put entry in Design FAQ after a question about a context manager for assignment.
Original patch by Aidan Lowe.
2021-06-21 17:23:29 -04:00
Kazantcev Andrey 93d33b47af
Fix typo in the word "spaghetti" (GH-24866)
Automerge-Triggered-By: GH:Mariatta
2021-03-15 10:23:03 -07:00
Terry Jan Reedy 5e29021a5e
bpo-43199: Briefly explain why no goto (GH-24852)
Answer "Why is there no goto?" in the Design and History FAQ.
2021-03-14 18:12:04 -04:00
Daniel F Moisset a22bca6b1e
bpo-42128: Add documentation for pattern matching (PEP 634) (#24664)
This is a first edition, ready to go out with the implementation. We'll iterate during the rest of the period leading up to 3.10.0.

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Fidget-Spinner <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandt@python.org>
Co-authored-by: Raymond Hettinger <1623689+rhettinger@users.noreply.github.com>
Co-authored-by: Guido van Rossum <guido@python.org>
2021-02-28 20:08:38 -08:00
Andre Delfino dea82b6731
[doc] Remove references to PyChecker. (GH-22011) 2020-09-01 22:21:12 -05:00
Alex Povel fd33cdbd05
Fix plural typo in documentation (GH-19799)
Co-authored-by: Alex Povel <python@alexpovel.de>
2020-04-29 19:17:12 -03:00
Adorilson Bezerra 5807efd4c3
bpo-38558: Link to further docs from walrus operator mention in tutorial (GH-16973) 2020-02-03 18:11:19 +01:00
Emily Morehouse 6357c95716 bpo-35224: Additional documentation for Assignment Expressions (GH-15935)
Add or update assignment expression documentation for:
- FAQ - Design
- Reference - Expressions
- Reference - Lexical Analysis


https://bugs.python.org/issue35224



Automerge-Triggered-By: @matrixise
2019-09-11 07:37:12 -07:00
Ilya Kamenshchikov a0f7119f15 bpo-37352: Minor word-smithing for design.rst (GH #14730) 2019-07-16 08:13:38 -07:00
Aeros d0068000b2 Docs: Improved phrasing (GH-14069)
* Docs: Improved phrasing 

Removed usage of second person pronouns in the section and made the assumption of "uneasiness" in code style transition more neutral.

* Removed trailing whitespace on line 34
2019-06-20 21:43:07 -07: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
INADA Naoki c48e26dcad
bpo-27671: Update FAQ about why len is function (GH-8432) 2018-07-31 14:49:22 +09:00
Andrés Delfino 8d41278045 bpo-33888: Use CPython instead of Python in the FAQ (GH-7767)
Make the change where discussing the CPython implementation of lists and dicts.
2018-07-07 19:25:47 -04:00
Julien Palard a6e1e41e05 Update Stackless Python wiki URL (GH-8072)
It was moved from bitbucket to GitHub.
2018-07-04 21:31:38 -07:00
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) 866c168a5f bpo-33957: Doc: Use better wording (GH-7912) 2018-06-26 17:27:05 +09:00
Andrés Delfino 38cf49bf69 bpo-33887: Add TOC to Design and History FAQ(GH-7766) 2018-06-23 11:27:16 -07:00
Andrés Delfino 396ecb9c3e bpo-33799: Remove non-ordered dicts comments from FAQ 2018-06-08 15:38:07 +09:00
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01: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
Brett Cannon 78ffd6cffa Issue #28705: greatly simplify the FAQ entry on transpiling.
This also eliminats a dead link to Weave in the process.
2016-11-18 10:41:28 -08:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +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
Georg Brandl 77fe77d4af Fixing broken links in doc, part 1: faq/ 2014-10-29 09:24:54 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 9205e9ebdc Closes #16155: fix a few errors in doctest output of the FAQ pages. 2014-10-06 17:51:09 +02:00
Ezio Melotti 898eb82696 #20135: move FAQ about mutable default arguments to the programming FAQs page. 2014-07-06 20:53:27 +03:00
Serhiy Storchaka bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Georg Brandl 242e6a0bce Use "lambda expression" as preferred to "lambda form". 2013-10-06 10:28:39 +02:00
Georg Brandl 7b8c1324d7 Closes #17726: small clarification in design FAQ. 2013-04-14 10:31:06 +02:00
Ezio Melotti 9f6a239cf1 #16862: merge with 3.2. 2013-01-05 07:38:37 +02:00
Ezio Melotti 7449231eca #16862: remove outdated statements about Stackless. 2013-01-05 07:37:47 +02:00
Ezio Melotti 9beeefbb45 Cleanup a few minor things. 2013-01-05 07:36:54 +02:00
Ezio Melotti 87b83dd18c Merge example fix with 3.2. 2013-01-05 06:54:23 +02:00
Ezio Melotti 19cdee891e Fix example by making the exception inherit from Exception. 2013-01-05 06:53:27 +02:00