FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-107298: Fix numerous ref errors and typos in the C API docs by serhiy-storchaka · Pull Request #108258 · python/cpython · GitHub

/ cpython Public

gh-107298: Fix numerous ref errors and typos in the C API docs - #108258

Merged
serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:docs-capi-refs
Aug 22, 2023
ConversationCommits (1)ChecksFiles changed
Merged

gh-107298: Fix numerous ref errors and typos in the C API docs#108258
serhiy-storchaka merged 1 commit into
python:mainfrom
serhiy-storchaka:docs-capi-refs

Conversation

serhiy-storchaka commented Aug 22, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

bedevere-bot added docs Documentation in the Doc dir skip news labels Aug 22, 2023
bedevere-bot mentioned this pull request Aug 22, 2023
Closed
serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 22, 2023
vstinner approved these changes Aug 22, 2023
View reviewed changes

vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM. But I'm not sure if Doc/c-api/exceptions.rst changes are related.

Comment thread Doc/c-api/exceptions.rst
that if *filename* is not ``NULL``, it is decoded from the filesystem
encoding (:func:`os.fsdecode`) and passed to the constructor of
:exc:`OSError` as a third parameter to be used to define the
:attr:`!filename` attribute of the exception instance.

vstinner Aug 22, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm not sure if Doc/c-api/exceptions.rst changes are related or not? They don't seem to fix Sphinx warnings.

serhiy-storchaka Aug 22, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Both descriptions referred non-existing function

PyObject* PyErr_SetFromWindowsErrWithFilenameObject(int ierr, PyObject *filenameObject);

There is no, and never was such function.

So I rewrote the descriptions by referring other functions, using descriptions of other functions which add the filename parameter as an example.

It fixes 2 of 10 warnings in Doc/c-api/exceptions.rst.

vstinner Aug 22, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh I didn't notice, ok. Well, I approved your PR ;-)

serhiy-storchaka merged commit d7202e4 into python:main Aug 22, 2023

miss-islington commented Aug 22, 2023

Copy link
Copy Markdown
Contributor

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

serhiy-storchaka deleted the docs-capi-refs branch August 22, 2023 12:50

miss-islington commented Aug 22, 2023

Copy link
Copy Markdown
Contributor

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

bedevere-bot commented Aug 22, 2023

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 22, 2023
pythongh-107298: Fix numerous ref errors and typos in the C API docs (p…
563c000 
…ythonGH-108258)

(cherry picked from commit d7202e4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 22, 2023
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Aug 22, 2023
[3.11] pythongh-107298: Fix numerous ref errors and typos in the C AP…
9743e17 
…I docs (pythonGH-108258).

(cherry picked from commit d7202e4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

bedevere-bot commented Aug 22, 2023

Copy link
Copy Markdown

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

bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 22, 2023
Yhg1s pushed a commit that referenced this pull request Aug 22, 2023
[3.12] gh-107298: Fix numerous ref errors and typos in the C API docs (…
e5d779c 
…GH-108258) (#108284)

gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
(cherry picked from commit d7202e4)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
ambv pushed a commit that referenced this pull request Aug 22, 2023
[3.11] gh-107298: Fix numerous ref errors and typos in the C API docs (…
3ca9264 
…GH-108258) (#108290)

(cherry picked from commit d7202e4)
serhiy-storchaka removed their assignment Sep 8, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

vstinner vstinner approved these changes

Assignees

No one assigned

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.

4 participants

Back | FazBrowse Home | New Git URL