gh-107801: Improve the accuracy of os.lseek docs by erlend-aasland · Pull Request #107935 · python/cpython · GitHub
Skip to content

gh-107801: Improve the accuracy of os.lseek docs#107935

Merged
erlend-aasland merged 8 commits intopython:mainfrom
erlend-aasland:docs/os.lseek
Aug 18, 2023
Merged

gh-107801: Improve the accuracy of os.lseek docs#107935
erlend-aasland merged 8 commits intopython:mainfrom
erlend-aasland:docs/os.lseek

Conversation

@erlend-aasland
Copy link
Copy Markdown
Contributor

@erlend-aasland erlend-aasland commented Aug 14, 2023 •
edited by github-actions Bot
Loading

  • name the last parameter whence, like it is for seek() methods on
    file objects
  • add param docstrings
  • structure the valid whence values as a list

📚 Documentation preview 📚: https://cpython-previews--107935.org.readthedocs.build/

@erlend-aasland
pythongh-107801: Improve the accuracy of os.lseek docs
3254ff5 
- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* values as a list
@bedevere-bot bedevere-bot mentioned this pull request Aug 14, 2023
Closed
AA-Turner
AA-Turner approved these changes Aug 14, 2023
View reviewed changes
Comment thread Modules/posixmodule.c Outdated
Comment thread Modules/posixmodule.c
Comment thread Doc/library/os.rst Outdated
@erlend-aasland @AA-Turner
Update Doc/library/os.rst
12b0471 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 14, 2023 21:05
serhiy-storchaka
serhiy-storchaka reviewed Aug 15, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment in #107936 (review). These changes are not independent and should be considered in one PR.

@erlend-aasland
Copy link
Copy Markdown
Contributor Author

erlend-aasland commented Aug 15, 2023

@erlend-aasland
Copy link
Copy Markdown
Contributor Author

erlend-aasland commented Aug 15, 2023

I'll hold this until #107936 has landed.

AA-Turner
AA-Turner approved these changes Aug 18, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

A

@erlend-aasland erlend-aasland merged commit dd4442c into python:main Aug 18, 2023
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Aug 18, 2023

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Aug 18, 2023

Sorry, @erlend-aasland, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker dd4442c8f597af1ec3eaf20f7ad89c4ac7e2dbc9 3.12

@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Aug 18, 2023

Sorry, @erlend-aasland, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker dd4442c8f597af1ec3eaf20f7ad89c4ac7e2dbc9 3.11

@erlend-aasland erlend-aasland deleted the docs/os.lseek branch August 19, 2023 12:07
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Aug 19, 2023

GH-108136 is a backport of this pull request to the 3.12 branch.

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner
[3.12] pythongh-107801: Improve the accuracy of os.lseek docs (python…
953b52d 
…#107935)

- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* params

(cherry picked from commit dd4442c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 19, 2023
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Aug 19, 2023

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 19, 2023
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner
[3.11] pythongh-107801: Improve the accuracy of os.lseek docs (python…
c66cbe9 
…#107935)

- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* params

(cherry picked from commit dd4442c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
erlend-aasland added a commit that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner
[3.11] gh-107801: Improve the accuracy of os.lseek docs (#107935) (#1…
e0ca342 
…08137)

- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* params

(cherry picked from commit dd4442c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner
[3.12] gh-107801: Improve the accuracy of os.lseek docs (#107935) (#1…
41634ed 
…08136)

- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* params

(cherry picked from commit dd4442c)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments

@pitrou pitrou pitrou approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees

@erlend-aasland erlend-aasland

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@erlend-aasland @miss-islington @bedevere-bot @pitrou @serhiy-storchaka @AA-Turner