GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-107801: Improve the accuracy of os.lseek docs by erlend-aasland · Pull Request #107935 · python/cpython

Conversation

erlend-aasland commented Aug 14, 2023 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Contributor

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

Issue: Docs and docstrings for io.*.seek are inconsistent #107801

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          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

erlend-aasland added skip news needs backport to 3.11

only security fixes

needs backport to 3.12 only security fixes labels

Aug 14, 2023

erlend-aasland requested review from AA-Turner, pitrou and serhiy-storchaka

August 14, 2023 11:11

bedevere-bot mentioned this pull request

Aug 14, 2023

Docs and docstrings for io.*.seek are inconsistent #107801

Closed

bedevere-bot added the awaiting core review label

Aug 14, 2023


          Regen clinic

0c57eef

AA-Turner approved these changes

Aug 14, 2023

View reviewed changes

Comment thread

Modules/posixmodule.c Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Modules/posixmodule.c Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/library/os.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

pitrou approved these changes

Aug 14, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels

Aug 14, 2023


          Update Doc/library/os.rst

12b0471

Co-authored-by: Adam Turner <[email protected]>

erlend-aasland enabled auto-merge (squash)

August 14, 2023 21:05

erlend-aasland disabled auto-merge

August 14, 2023 21:19

serhiy-storchaka reviewed

Aug 15, 2023

View reviewed changes

serhiy-storchaka left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

erlend-aasland commented Aug 15, 2023

Copy link

Copy Markdown

Contributor Author

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

I think it is fine to document constants in one PR and update the docs of the function in another PR. Documenting the constants also unlock my draft PR to clean up the Sphinx warnings in Lib/library/os.rst.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland added 2 commits

August 15, 2023 12:30


          Pull in main

e54dc45


          Revert summary line change

ca27fca

erlend-aasland commented Aug 15, 2023

Copy link

Copy Markdown

Contributor Author

I'll hold this until #107936 has landed.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland added 3 commits

August 17, 2023 21:53


          Pull in main

1a40cfa


          Pull in main

59a38c4


          Add short description of HOLE/DATA

aa568d3

erlend-aasland requested a review from AA-Turner

August 18, 2023 09:26

AA-Turner approved these changes

Aug 18, 2023

View reviewed changes

AA-Turner left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Looks good!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland reacted with hooray emoji

All reactions

🎉 1 reaction

erlend-aasland merged commit dd4442c into python:main

Aug 18, 2023

miss-islington commented Aug 18, 2023

Copy link

Copy Markdown

Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-bot removed the awaiting merge label

Aug 18, 2023

miss-islington commented Aug 18, 2023

Copy link

Copy Markdown

Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington assigned erlend-aasland

Aug 18, 2023

miss-islington commented Aug 18, 2023

Copy link

Copy Markdown

Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland deleted the docs/os.lseek branch

August 19, 2023 12:07

bedevere-bot commented Aug 19, 2023

Copy link

Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request

Aug 19, 2023


          [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 <[email protected]>

bedevere-bot removed the needs backport to 3.12 only security fixes label

Aug 19, 2023

bedevere-bot commented Aug 19, 2023

Copy link

Copy Markdown

GH-108137 is a backport of this pull request to the 3.11 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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


          [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 <[email protected]>

erlend-aasland added a commit that referenced this pull request

Aug 19, 2023


          [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 <[email protected]>

Yhg1s pushed a commit that referenced this pull request

Aug 19, 2023


          [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 <[email protected]>

Reviewers

serhiy-storchaka

serhiy-storchaka left review comments

pitrou

pitrou approved these changes

AA-Turner

AA-Turner approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

erlend-aasland

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

erlend-aasland commented Aug 14, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland commented Aug 15, 2023

Uh oh!

erlend-aasland commented Aug 15, 2023

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Aug 18, 2023

Uh oh!

miss-islington commented Aug 18, 2023

Uh oh!

miss-islington commented Aug 18, 2023

Uh oh!

bedevere-bot commented Aug 19, 2023

Uh oh!

bedevere-bot commented Aug 19, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

erlend-aasland commented Aug 14, 2023 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.