Skip to content

Conversation

@serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Oct 26, 2025

  • Refer to bytes objects or bytes-like objects instead of strings.
  • Remove backticks -- they do not have effect on formatting.
  • Re-wrap lines to ensure the pydoc output fits in 80 coluimns.
  • Remove references to the 1024 bytes limit.

* Refer to bytes objects or bytes-like objects instead of strings.
* Remove backticks -- they do not have effect on formatting.
* Re-wrap lines to ensure the pydoc output fits in 80 coluimns.
* Remove references to the 1024 bytes limit.
@serhiy-storchaka serhiy-storchaka requested a review from a team October 26, 2025 09:45
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 26, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 26, 2025
@serhiy-storchaka
Copy link
Member Author

References to the 1024 bytes limit should be restored in the backport to 3.13.

@mwichmann
Copy link

No "proofreading" comments from me, anyway. How are docstrings-in-C processed? The sometimes-followed convention in Python code is to use *param* markup to refer to a function's arguments within its own docstring.

@serhiy-storchaka
Copy link
Member Author

The same as in Python -- they are not processed, besides stripping spaces and dedenting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants