Skip to content

gh-140615: Update docstrings in the fcntl module #140619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 8, 2025
Merged

gh-140615: Update docstrings in the fcntl module #140619

merged 1 commit into from
Nov 8, 2025

Conversation

@serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Oct 26, 2025 •
edited by bedevere-app bot
Loading

  • 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
pythongh-140615: Update docstrings in the fcntl module
964cf91 
* 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
@bedevere-app bedevere-app bot mentioned this pull request Oct 26, 2025
Closed
@serhiy-storchaka
Copy link
Member Author

serhiy-storchaka commented Oct 26, 2025

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

@mwichmann
Copy link

mwichmann commented Oct 26, 2025

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

serhiy-storchaka commented Oct 26, 2025

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

@serhiy-storchaka serhiy-storchaka merged commit 6103770 into python:main Nov 8, 2025
53 checks passed
@miss-islington-app
Copy link

miss-islington-app bot commented Nov 8, 2025

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Nov 8, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Nov 8, 2025

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 610377056bad696915d70590429e68002bee9006 3.14

@miss-islington-app
Copy link

miss-islington-app bot commented Nov 8, 2025

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 610377056bad696915d70590429e68002bee9006 3.13

@serhiy-storchaka serhiy-storchaka deleted the fcntl-docstrings branch November 8, 2025 10:18
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Nov 8, 2025
@serhiy-storchaka
[3.14] pythongh-140615: Update docstrings in the fcntl module (python…
cb4f7c4 
…GH-140619)

* 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.
(cherry picked from commit 6103770)

Co-authored-by: Serhiy Storchaka <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Nov 8, 2025

GH-141231 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 8, 2025
@serhiy-storchaka serhiy-storchaka removed the needs backport to 3.13 bugs and security fixes label Nov 8, 2025
serhiy-storchaka added a commit that referenced this pull request Nov 8, 2025
@serhiy-storchaka
[3.14] gh-140615: Update docstrings in the fcntl module (GH-140619) (G…
1a08019 
…H-141231)

* 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 columns.
(cherry picked from commit 6103770)

Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Nov 8, 2025
@serhiy-storchaka
[3.13] pythongh-140615: Update docstrings in the fcntl module (python…
9d8ed67 
…GH-140619) (pythonGH-141231)

* 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 columns.
(cherry picked from commit 6103770)
(cherry picked from commit 1a08019)

Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit that referenced this pull request Nov 8, 2025
@serhiy-storchaka
[3.13] gh-140615: Update docstrings in the fcntl module (GH-140619) (G…
731832a 
…H-141231) (GH-141232)

* 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 columns.
(cherry picked from commit 6103770)
(cherry picked from commit 1a08019)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@serhiy-storchaka serhiy-storchaka

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@serhiy-storchaka @mwichmann @StanFromIreland