# \#documentation

**URL:** https://discuss.python.org/tag/documentation/14.md

[Latest](https://discuss.python.org/latest.md) · [Categories](https://discuss.python.org/categories.md) · [Tags](https://discuss.python.org/tags.md)

---

## [Docstrings for type aliases](https://discuss.python.org/t/docstrings-for-type-aliases/108901)

<div class="topic-metadata">

**Author:** [@bswck](https://discuss.python.org/u/bswck)\
**Replies:** 27\
**Last updated:** [October 23, 2026, 5:23pm UTC](https://discuss.python.org/t/docstrings-for-type-aliases/108901 "2026-10-23T17:23:31Z")

</div>

Hi! I propose preserving a string literal immediately following a type statement as the resulting alias object’s \_\_doc\_\_ attribute, with support in pydoc to display it in help(), and making that docstring retrievable fro…

---

## [Foreign key constraints in SQLite](https://discuss.python.org/t/foreign-key-constraints-in-sqlite/109058)

<div class="topic-metadata">

**Author:** [@decorator-factory](https://discuss.python.org/u/decorator-factory)\
**Replies:** 3\
**Last updated:** [September 16, 2026, 7:58am UTC](https://discuss.python.org/t/foreign-key-constraints-in-sqlite/109058 "2026-09-16T07:58:29Z")

</div>

(not sure what the right category is… maybe this is a documentation issue? ) For backwards compatibility, foreign keys are disabled in SQLite by default (SQLite Foreign Key Support), and you need to enable them explicit…

---

## [Starting Punjabi (pa-IN) Translation of Python Documentation](https://discuss.python.org/t/starting-punjabi-pa-in-translation-of-python-documentation/107807)

<div class="topic-metadata">

**Author:** [@BHUVANSH855](https://discuss.python.org/u/BHUVANSH855)\
**Replies:** 3\
**Last updated:** [September 8, 2026, 2:26pm UTC](https://discuss.python.org/t/starting-punjabi-pa-in-translation-of-python-documentation/107807 "2026-09-08T14:26:58Z")

</div>

Hello everyone, I have started a Punjabi (India) translation effort for the Python documentation and would like to introduce the project and ask for guidance from the documentation translation community. Repository: …

---

## [Deprecate function arguments](https://discuss.python.org/t/deprecate-function-arguments/103672)

<div class="topic-metadata">

**Author:** [@oliversheridanmethven](https://discuss.python.org/u/oliversheridanmethven)\
**Replies:** 6\
**Last updated:** [August 26, 2026, 5:06pm UTC](https://discuss.python.org/t/deprecate-function-arguments/103672 "2026-08-26T17:06:45Z")

</div>

Based on this ticket I raised on mypy: Support for deprecating function arguments · Issue #19817 · python/mypy · GitHub (While the below names mypy, this extends to other type checkers. ) Feature Currently we can depr…

---

## [Include time and space complexity in documentation](https://discuss.python.org/t/include-time-and-space-complexity-in-documentation/105683)

<div class="topic-metadata">

**Author:** [@heikkitoivonen](https://discuss.python.org/u/heikkitoivonen)\
**Replies:** 26\
**Last updated:** [August 25, 2026, 9:19pm UTC](https://discuss.python.org/t/include-time-and-space-complexity-in-documentation/105683 "2026-08-25T21:19:13Z")

</div>

I just found TimeComplexity wiki page, which I think is great. However, it covers just list, set, dict and collections.deque. Discoverability is also an issue. I think it would be great if we started including time and s…

---

## [Logging config documentation is too restrictive wrt ext:// and cfg:// references in custom objects](https://discuss.python.org/t/logging-config-documentation-is-too-restrictive-wrt-ext-and-cfg-references-in-custom-objects/108689)

<div class="topic-metadata">

**Author:** [@karolinepauls](https://discuss.python.org/u/karolinepauls)\
**Replies:** 1\
**Last updated:** [August 22, 2026, 10:26am UTC](https://discuss.python.org/t/logging-config-documentation-is-too-restrictive-wrt-ext-and-cfg-references-in-custom-objects/108689 "2026-08-22T10:26:52Z")

</div>

Problem description The docs warn that for the following formatter config… formatters: custom: (): my.package.customFormatterFactory bar: baz spam: 99.9 answer: 42 … following restriction…

---

## [Concurrent.futures ProcessPoolExecutor Example does not work in Python 3.14](https://discuss.python.org/t/concurrent-futures-processpoolexecutor-example-does-not-work-in-python-3-14/108669)

<div class="topic-metadata">

**Author:** [@jnsdrtlf](https://discuss.python.org/u/jnsdrtlf)\
**Replies:** 2\
**Last updated:** [August 20, 2026, 10:15pm UTC](https://discuss.python.org/t/concurrent-futures-processpoolexecutor-example-does-not-work-in-python-3-14/108669 "2026-08-20T22:15:04Z")

</div>

The example code for the ProcessPoolExecutor listed on the concurrent.futures page does not actually run on Python 3.14 (I only tested on Linux). This seems to be caused by the change of the start method away from fork a…

---

## [Django Best Practices](https://discuss.python.org/t/django-best-practices/108634)

<div class="topic-metadata">

**Author:** [@amielia](https://discuss.python.org/u/amielia)\
**Replies:** 0\
**Last updated:** [August 18, 2026, 6:30am UTC](https://discuss.python.org/t/django-best-practices/108634 "2026-08-18T06:30:22Z")

</div>

I’m working on a Django project and trying to keep the codebase maintainable as it grows. I’m interested in hearing what practices other Django developers consider most important for production applications, especially …

---

## [Modify the python grammar and matching to the correct error message?](https://discuss.python.org/t/modify-the-python-grammar-and-matching-to-the-correct-error-message/108450)

<div class="topic-metadata">

**Author:** [@blaisep](https://discuss.python.org/u/blaisep)\
**Replies:** 1\
**Last updated:** [August 6, 2026, 7:15pm UTC](https://discuss.python.org/t/modify-the-python-grammar-and-matching-to-the-correct-error-message/108450 "2026-08-06T19:15:52Z")

</div>

I’m memorializing here (and also asking) because IMHO , the discussion on the python discord #esoteric-python is ephemeral. Anyo suggestions for troubleshooting the mapping of error messages to grammar? …currently the …

---

## [Docs improvement suggestion. An ambiguity in the \`Future.cancel\` for non-native English speakers](https://discuss.python.org/t/docs-improvement-suggestion-an-ambiguity-in-the-future-cancel-for-non-native-english-speakers/108328)

<div class="topic-metadata">

**Author:** [@chyin6](https://discuss.python.org/u/chyin6)\
**Replies:** 3\
**Last updated:** [July 30, 2026, 1:44pm UTC](https://discuss.python.org/t/docs-improvement-suggestion-an-ambiguity-in-the-future-cancel-for-non-native-english-speakers/108328 "2026-07-30T13:44:00Z")

</div>

Sorry, I’m not a native English speaker, and the following document does confuse me for some time. If the call is currently being executed or finished running and cannot be cancelled then the method will return False W…

---

## [Standardizing Docstring Conventions for Exception Groups (PEP 654/\`except\*\`)](https://discuss.python.org/t/standardizing-docstring-conventions-for-exception-groups-pep-654-except/108231)

<div class="topic-metadata">

**Author:** [@gtkacz](https://discuss.python.org/u/gtkacz)\
**Replies:** 10\
**Last updated:** [July 28, 2026, 9:44am UTC](https://discuss.python.org/t/standardizing-docstring-conventions-for-exception-groups-pep-654-except/108231 "2026-07-28T09:44:58Z")

</div>

PEP 654 introduced ExceptionGroup and BaseExceptionGroup alongside the except\* syntax in Python 3.11. While PEP 654 defined the runtime mechanics and interpreter behavior for exception groups, it did not address docstrin…

---

## [Pycon Poster size and formats](https://discuss.python.org/t/pycon-poster-size-and-formats/108238)

<div class="topic-metadata">

**Author:** [@blaisep](https://discuss.python.org/u/blaisep)\
**Replies:** 1\
**Last updated:** [July 22, 2026, 3:08pm UTC](https://discuss.python.org/t/pycon-poster-size-and-formats/108238 "2026-07-22T15:08:34Z")

</div>

In Europe and most other places, the size of a printed Pycon poster is A0 (1,189 mm × 841 mm) Paper size - Wikipedia @encukou asked me what size was used in the USA and I didn’t know for sure. Edit: apparently the USA …

---

## [How can I set the default Python version that gets launched when typing python3 (On Windows 11)?](https://discuss.python.org/t/how-can-i-set-the-default-python-version-that-gets-launched-when-typing-python3-on-windows-11/106469)

<div class="topic-metadata">

**Author:** [@futuremotion](https://discuss.python.org/u/futuremotion)\
**Replies:** 6\
**Last updated:** [July 21, 2026, 7:38am UTC](https://discuss.python.org/t/how-can-i-set-the-default-python-version-that-gets-launched-when-typing-python3-on-windows-11/106469 "2026-07-21T07:38:34Z")

</div>

Overview My exact goal is to set my preferred version of python as the default when I type python3 into a command prompt or powershell prompt. I’ve tried everything but can’t figure it out. I have the following Python v…

---

## [New iCalendar for Docs Community meetings](https://discuss.python.org/t/new-icalendar-for-docs-community-meetings/106788)

<div class="topic-metadata">

**Author:** [@Stanfromireland](https://discuss.python.org/u/Stanfromireland)\
**Replies:** 5\
**Last updated:** [July 9, 2026, 11:48am UTC](https://discuss.python.org/t/new-icalendar-for-docs-community-meetings/106788 "2026-07-09T11:48:20Z")

</div>

We now have an automatically generated and updated iCalendar feed for our monthly meetings, which can be found at: https://docs-community.readthedocs.io/docs-community-meetings.ics The monthly meetings page now also fe…

---

## [Python 3.10 EOL: Is there an official end-of-support date within October 2026?](https://discuss.python.org/t/python-3-10-eol-is-there-an-official-end-of-support-date-within-october-2026/108064)

<div class="topic-metadata">

**Author:** [@samirKenobi](https://discuss.python.org/u/samirKenobi)\
**Replies:** 2\
**Last updated:** [July 6, 2026, 9:28pm UTC](https://discuss.python.org/t/python-3-10-eol-is-there-an-official-end-of-support-date-within-october-2026/108064 "2026-07-06T21:28:24Z")

</div>

Hello team, I am looking for clarification on the Python 3.10 end-of-life schedule. The Python Developer Guide currently lists Python 3.10 as reaching end of life in October 2026, and PEP 619 describes the Python 3.10 …

---

## [How to make link that displays as a code span in reStructuredText?](https://discuss.python.org/t/how-to-make-link-that-displays-as-a-code-span-in-restructuredtext/107753)

<div class="topic-metadata">

**Author:** [@mfile\_bay](https://discuss.python.org/u/mfile_bay)\
**Replies:** 2\
**Last updated:** [June 14, 2026, 6:00am UTC](https://discuss.python.org/t/how-to-make-link-that-displays-as-a-code-span-in-restructuredtext/107753 "2026-06-14T06:00:47Z")

</div>

In Markdown that’s \[\`aaa\`\](https://example.com). How to do it in RST?

---

## [Starting Vietnamese Translation](https://discuss.python.org/t/starting-vietnamese-translation/107028)

<div class="topic-metadata">

**Author:** [@tamnd](https://discuss.python.org/u/tamnd)\
**Replies:** 0\
**Last updated:** [April 18, 2026, 11:11am UTC](https://discuss.python.org/t/starting-vietnamese-translation/107028 "2026-04-18T11:11:11Z")

</div>

Hello everyone, I’m starting a Vietnamese translation of the Python documentation. The goal is simple: make Python easier to learn and use for Vietnamese speakers, especially students and beginners who prefer reading in…

---

## [Recommend against (or for?) pathlib.Path.open](https://discuss.python.org/t/recommend-against-or-for-pathlib-path-open/106904)

<div class="topic-metadata">

**Author:** [@trey](https://discuss.python.org/u/trey)\
**Replies:** 11\
**Last updated:** [April 13, 2026, 4:17pm UTC](https://discuss.python.org/t/recommend-against-or-for-pathlib-path-open/106904 "2026-04-13T16:17:30Z")

</div>

When working with pathlib.Path objects, I have been recommending the use of open(path) over path.open() and it’s been brought to my attention that this recommendation is at odds with some linter rules, such as ruff’s PTH…

---

## [Documenting Use of \`abc.abstractmethod\` in Non-\`ABCMeta\` Classes](https://discuss.python.org/t/documenting-use-of-abc-abstractmethod-in-non-abcmeta-classes/106055)

<div class="topic-metadata">

**Author:** [@matthewyu0311](https://discuss.python.org/u/matthewyu0311)\
**Replies:** 4\
**Last updated:** [February 8, 2026, 5:16pm UTC](https://discuss.python.org/t/documenting-use-of-abc-abstractmethod-in-non-abcmeta-classes/106055 "2026-02-08T17:16:33Z")

</div>

The docs on @abc.abstractmethod currently states: Using this decorator requires that the class’s metaclass is ABCMeta or is derived from it. This is not actually true. The decorator can be applied to methods of non-a…

---

## [Understanding asyncio.subprocess.Process garbage collection](https://discuss.python.org/t/understanding-asyncio-subprocess-process-garbage-collection/105973)

<div class="topic-metadata">

**Author:** [@eike](https://discuss.python.org/u/eike)\
**Replies:** 11\
**Last updated:** [February 3, 2026, 6:24pm UTC](https://discuss.python.org/t/understanding-asyncio-subprocess-process-garbage-collection/105973 "2026-02-03T18:24:47Z")

</div>

The documentation on asyncio.create\_subprocess\_exec claims: If the process object is garbage collected while the process is still running, the child process will be killed. However, I cannot get this to work. For exa…

---

## [Looking for feedback on my typing guide for Python 3.14](https://discuss.python.org/t/looking-for-feedback-on-my-typing-guide-for-python-3-14/105902)

<div class="topic-metadata">

**Author:** [@JBogorad](https://discuss.python.org/u/JBogorad)\
**Replies:** 18\
**Last updated:** [January 30, 2026, 8:01pm UTC](https://discuss.python.org/t/looking-for-feedback-on-my-typing-guide-for-python-3-14/105902 "2026-01-30T20:01:49Z")

</div>

Hi all — I’ve been working on a Python 3.14 typing guide and am sharing it publicly in hopes that other people find it useful and/or can make it better. It’s not a reference manual or a PEP summary. It’s an attempt to e…

---

## [Canonical Design & Doc clinics at post-FOSDEM](https://discuss.python.org/t/canonical-design-doc-clinics-at-post-fosdem/105909)

<div class="topic-metadata">

**Author:** [@astrojuanlu](https://discuss.python.org/u/astrojuanlu)\
**Replies:** 3\
**Last updated:** [January 30, 2026, 10:18am UTC](https://discuss.python.org/t/canonical-design-doc-clinics-at-post-fosdem/105909 "2026-01-30T10:18:14Z")

</div>

Hello everyone! My good colleagues at Canonical are hosting Design and Documentation clinics at FOSDEM Fringe 2026. If your project could use help on UX/UI, documentation structure and strategy, DocOps tooling… you can …

---

## [What is iterators and generators?](https://discuss.python.org/t/what-is-iterators-and-generators/105762)

<div class="topic-metadata">

**Author:** [@sarveshpandey23](https://discuss.python.org/u/sarveshpandey23)\
**Replies:** 5\
**Last updated:** [January 21, 2026, 9:01pm UTC](https://discuss.python.org/t/what-is-iterators-and-generators/105762 "2026-01-21T21:01:24Z")

</div>

I need to understand what is iterator and generators. I looked into YouTube and gone through documents but didn’t get it. What is the purpose, impact and where and when one can use it? Its quite confusing. Please help.

---

## [Proposal for a built-in average() function](https://discuss.python.org/t/proposal-for-a-built-in-average-function/105796)

<div class="topic-metadata">

**Author:** [@ireshdilsh](https://discuss.python.org/u/ireshdilsh)\
**Replies:** 7\
**Last updated:** [January 20, 2026, 9:56am UTC](https://discuss.python.org/t/proposal-for-a-built-in-average-function/105796 "2026-01-20T09:56:32Z")

</div>

Hello python community, I would like to propose adding average() as a built-in function to Python, similar to sum(), len(), max(), and min(). Currently, users have to import statistics to use mean(). I believe average(…

---

## [Unexpected Python String Quotation Behavior in f-Strings](https://discuss.python.org/t/unexpected-python-string-quotation-behavior-in-f-strings/105755)

<div class="topic-metadata">

**Author:** [@EshangShah29](https://discuss.python.org/u/EshangShah29)\
**Replies:** 2\
**Last updated:** [January 15, 2026, 11:58pm UTC](https://discuss.python.org/t/unexpected-python-string-quotation-behavior-in-f-strings/105755 "2026-01-15T23:58:55Z")

</div>

This is a bit of a curveball for me. some\_letters = "abcdadedf sdqadassaa" print(f"number of letter m: {some\_letters.count("a")}") I would expect this to throw a syntax error because the quotation marks are nested inco…

---

## [Argparse: Multiple arguments with the same destination left-to-right order guarantee](https://discuss.python.org/t/argparse-multiple-arguments-with-the-same-destination-left-to-right-order-guarantee/105685)

<div class="topic-metadata">

**Author:** [@pdgendt](https://discuss.python.org/u/pdgendt)\
**Replies:** 12\
**Last updated:** [January 14, 2026, 10:12pm UTC](https://discuss.python.org/t/argparse-multiple-arguments-with-the-same-destination-left-to-right-order-guarantee/105685 "2026-01-14T22:12:45Z")

</div>

Reading the argparse docs, I didn’t find a formal guarantee that arguments are parsed from left-to-right, or “in order”, which is especially useful for a “last argument wins” approach when using the same destination. Fo…

---

## [IDLE: Format Paragraph](https://discuss.python.org/t/idle-format-paragraph/105560)

<div class="topic-metadata">

**Author:** [@adorilson](https://discuss.python.org/u/adorilson)\
**Replies:** 3\
**Last updated:** [January 13, 2026, 6:25am UTC](https://discuss.python.org/t/idle-format-paragraph/105560 "2026-01-13T06:25:02Z")

</div>

What is the IDLE Format Paragraph’s purpose? If it is to format Python source code, there is a bug. Because it mixes two lines, a syntax error occurs when it runs. If the purpose is only to format the docstring (no exe…

---

## [Guidelines for acceptable performance optimizations?](https://discuss.python.org/t/guidelines-for-acceptable-performance-optimizations/105506)

<div class="topic-metadata">

**Author:** [@heikkitoivonen](https://discuss.python.org/u/heikkitoivonen)\
**Replies:** 6\
**Last updated:** [January 9, 2026, 8:16pm UTC](https://discuss.python.org/t/guidelines-for-acceptable-performance-optimizations/105506 "2026-01-09T20:16:47Z")

</div>

Python has been my main language since 2003, and I figured I should finally try to contribute directly to the language itself. My first idea was that I would look for simple micro-optimization ideas in the stdlib. My fir…

---

## [Py V3.14.2 turning into V3.6.1](https://discuss.python.org/t/py-v3-14-2-turning-into-v3-6-1/105494)

<div class="topic-metadata">

**Author:** [@cookie1](https://discuss.python.org/u/cookie1)\
**Replies:** 1\
**Last updated:** [January 4, 2026, 1:04am UTC](https://discuss.python.org/t/py-v3-14-2-turning-into-v3-6-1/105494 "2026-01-04T01:04:46Z")

</div>

py down grading no reason

---

## [Is IDLE menu doc outdated?](https://discuss.python.org/t/is-idle-menu-doc-outdated/105298)

<div class="topic-metadata">

**Author:** [@adorilson](https://discuss.python.org/u/adorilson)\
**Replies:** 2\
**Last updated:** [December 13, 2025, 5:06pm UTC](https://discuss.python.org/t/is-idle-menu-doc-outdated/105298 "2025-12-13T17:06:20Z")

</div>

The IDLE doc says: Output windows, such as used for Edit =\> Find in Files, are a subtype of editor window. They currently have the same top menu but a different default title and context menu. But, Edit =\> Find in file…

[Next page](https://discuss.python.org/tag/documentation/14.md?match_all_tags=true&page=1&tags%5B%5D=documentation)
