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.

Sign up for GitHub

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

Jump to bottom

PyObject_Format c-api function is not documented #102595

Closed
sobolevn opened this issue Mar 11, 2023 · 1 comment
Closed

PyObject_Format c-api function is not documented #102595

sobolevn opened this issue Mar 11, 2023 · 1 comment
Assignees
@sobolevn
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@sobolevn
Copy link
Member

sobolevn commented Mar 11, 2023 •
edited by bedevere-bot
Loading

Documentation

I think it must be, for the following reasons:

  1. It is a stable API that exists since python3
  2. It is implementing a builtin magic method __format__
  3. It is quite useful for others
  4. It is quite simple
  5. There are no plans to remove / deprecate it
  6. It is used in some parts of docs, example: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Doc/library/dis.rst#L1426

I will send a PR.

Linked PRs
@sobolevn sobolevn added type-feature A feature request or enhancement docs Documentation in the Doc dir labels Mar 11, 2023
@sobolevn sobolevn self-assigned this Mar 11, 2023
@bedevere-bot bedevere-bot mentioned this issue Mar 11, 2023
Merged
sobolevn added a commit to sobolevn/cpython that referenced this issue Mar 11, 2023
@sobolevn
pythongh-102595: Document PyObject_Format c-api function
f0059bd
miss-islington pushed a commit that referenced this issue Mar 21, 2023
@sobolevn
gh-102595: Document PyObject_Format c-api function (GH-102596)
910a64e 
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.h#L389
This was referenced Mar 21, 2023
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 21, 2023
@sobolevn @miss-islington
pythongh-102595: Document PyObject_Format c-api function (pythonGH-…
3ccbe6a 
…102596)

(cherry picked from commit 910a64e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 21, 2023
@sobolevn @miss-islington
pythongh-102595: Document PyObject_Format c-api function (pythonGH-…
eeaac1b 
…102596)

(cherry picked from commit 910a64e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
miss-islington added a commit that referenced this issue Mar 22, 2023
@miss-islington
[3.11] gh-102595: Document PyObject_Format c-api function (GH-102596)…
a7a373e 
… (GH-102879)

(cherry picked from commit 910a64e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389

Automerge-Triggered-By: GH:encukou
miss-islington added a commit that referenced this issue Mar 22, 2023
@miss-islington @sobolevn
gh-102595: Document PyObject_Format c-api function (GH-102596)
eaafea8 
(cherry picked from commit 910a64e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
@encukou
Copy link
Member

encukou commented Mar 22, 2023

Thank for the docs!

@encukou encukou closed this as completed Mar 22, 2023
Fidget-Spinner pushed a commit to Fidget-Spinner/cpython that referenced this issue Mar 27, 2023
@sobolevn @Fidget-Spinner
pythongh-102595: Document PyObject_Format c-api function (pythonGH-…
05078fd 
…102596)

Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.h#L389
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
@sobolevn @warsaw
pythongh-102595: Document PyObject_Format c-api function (pythonGH-…
973798f 
…102596)

Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.h#L389
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sobolevn sobolevn

Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@encukou @sobolevn