Skip to content
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.

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

gh-107801: Improve the accuracy of io.IOBase.seek docs #108268

Merged
merged 5 commits into from Aug 29, 2023

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Aug 22, 2023

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

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

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph
Copy link
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.

Thanks!

A

Doc/library/io.rst Outdated Show resolved Hide resolved
Doc/library/io.rst Outdated Show resolved Hide resolved
@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
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/library/io.rst Outdated Show resolved Hide resolved
@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
22 checks passed
@miss-islington

This comment was marked as outdated.

@miss-islington

This comment was marked as outdated.

@miss-islington

This comment was marked as outdated.

@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
…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 <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Aug 29, 2023
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 29, 2023
…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 <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot
Copy link

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

@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
… (#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 <9087854+AA-Turner@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Aug 29, 2023
… (#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 <9087854+AA-Turner@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this pull request Aug 30, 2023
* 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
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants