GV

GeezerVison

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

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-107801: Improve the accuracy of io.IOBase.seek docs by erlend-aasland · Pull Request #108268 · python/cpython

Conversation

@erlend-aasland

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

Uh oh!

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

Copy link
Copy Markdown
Contributor
  • Add param docstrings
  • Link to os.SEEK_* constants
  • Mention the return value in the initial paragraph
  • Issue: Docs and docstrings for io.*.seek are inconsistent #107801

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@erlend-aasland
pythongh-107801: Improve the accuracy of io.IOBase.seek docs
44c6575
- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph
@erlend-aasland erlend-aasland added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 22, 2023
@erlend-aasland
erlend-aasland requested a review from AA-Turner August 22, 2023 08:37
@bedevere-bot bedevere-bot mentioned this pull request Aug 22, 2023
Docs and docstrings for io.*.seek are inconsistent #107801
Closed
@bedevere-bot bedevere-bot added the awaiting core review label Aug 22, 2023
@erlend-aasland
Pull in main
a5b4bff
AA-Turner
AA-Turner approved these changes Aug 29, 2023
View reviewed changes

@AA-Turner 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.

Thanks!

A

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
Comment thread Doc/library/io.rst Resolved

Uh oh!

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

Comment thread Doc/library/io.rst Resolved

Uh oh!

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

@AA-Turner AA-Turner added the docs Documentation in the Doc dir label Aug 29, 2023
erlend-aasland and others added 2 commits August 29, 2023 18:57
@erlend-aasland @AA-Turner
Update io.rst
a2a6dc5
Co-authored-by: Adam Turner <[email protected]>
@erlend-aasland @AA-Turner
Update io.rst
bdbcf77
Co-authored-by: Adam Turner <[email protected]>
erlend-aasland
erlend-aasland commented Aug 29, 2023
View reviewed changes
Comment thread Doc/library/io.rst Resolved

Uh oh!

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

@erlend-aasland
Update Doc/library/io.rst
3fbef49
@erlend-aasland
erlend-aasland enabled auto-merge (squash) August 29, 2023 17:10
@erlend-aasland
erlend-aasland merged commit 8178a88 into python:main Aug 29, 2023
@bedevere-bot bedevere-bot removed the awaiting core review label Aug 29, 2023
@miss-islington

This comment was marked as outdated.

Sign in to view
@miss-islington

This comment was marked as outdated.

Sign in to view
@miss-islington miss-islington assigned erlend-aasland Aug 29, 2023
@miss-islington

This comment was marked as outdated.

Sign in to view
@erlend-aasland
erlend-aasland deleted the docs/iobase-seek branch August 29, 2023 19:15
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 29, 2023
@erlend-aasland @AA-Turner
[3.12] pythongh-107801: Improve the accuracy of io.IOBase.seek docs (p…
586b973
…ython#108268)

(cherry picked from commit 8178a88)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

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

bedevere-bot commented Aug 29, 2023

Copy link
Copy Markdown

GH-108655 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.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 29, 2023
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 29, 2023
@erlend-aasland @AA-Turner
[3.11] pythongh-107801: Improve the accuracy of io.IOBase.seek docs (p…
96f0b65
…ython#108268)

(cherry picked from commit 8178a88)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

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

bedevere-bot commented Aug 29, 2023

Copy link
Copy Markdown

GH-108656 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 bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 29, 2023
erlend-aasland added a commit that referenced this pull request Aug 29, 2023
@erlend-aasland @AA-Turner
[3.11] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268)…
d79216d
… (#108656)

(cherry picked from commit 8178a88)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <[email protected]>
Yhg1s pushed a commit that referenced this pull request Aug 29, 2023
@erlend-aasland @AA-Turner
[3.12] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268)…
036dd69
… (#108655)

(cherry picked from commit 8178a88)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <[email protected]>
carljm added a commit to carljm/cpython that referenced this pull request Aug 30, 2023
@carljm
Merge branch 'main' into icompexc
37377e6
* main:
  pythongh-108520: Fix bad fork detection in nested multiprocessing use case (python#108568)
  pythongh-108590: Revert pythongh-108657 (commit 400a1ce) (python#108686)
  pythongh-108494: Argument Clinic: Document how to generate code that uses the limited C API (python#108584)
  Document Python build requirements (python#108646)
  pythongh-101100: Fix Sphinx warnings in the Logging Cookbook (python#108678)
  Fix typo in multiprocessing docs (python#108666)
  pythongh-108669: unittest: Fix documentation for TestResult.collectedDurations (python#108670)
  pythongh-108590: Fix sqlite3.iterdump for invalid Unicode in TEXT columns (python#108657)
  Revert "pythongh-103224: Use the realpath of the Python executable in `test_venv` (pythonGH-103243)" (pythonGH-108667)
  pythongh-106320: Remove private _Py_ForgetReference() (python#108664)
  Mention Ellipsis pickling in the docs (python#103660)
  Revert "Use non alternate name for Kyiv (pythonGH-108533)" (pythonGH-108649)
  pythongh-108278: Deprecate passing the first param of sqlite3.Connection callback APIs by keyword (python#108632)
  pythongh-108455: peg_generator: install two stubs packages before running mypy (python#108637)
  pythongh-107801: Improve the accuracy of io.IOBase.seek docs (python#108268)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

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

Assignees

@erlend-aasland erlend-aasland

Labels

docs Documentation in the Doc dir 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.

4 participants

@erlend-aasland @miss-islington @bedevere-bot @AA-Turner
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.