Skip to content

PyObject_Format c-api function is not documented #102595

Closed
Closed
PyObject_Format c-api function is not documented#102595
Assignees
sobolevn
Labels
docsDocumentation in the Doc dirtype-featureA feature request or enhancement

Description

@sobolevn
sobolevn
opened on Mar 11, 2023

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

Activity

  1. sobolevn
    added
    type-featureA feature request or enhancement
    docsDocumentation in the Doc dir
    on Mar 11, 2023
  2. sobolevn
    self-assigned this
    on Mar 11, 2023
  3. sobolevn
    added a commit that references this issue on Mar 11, 2023

    pythongh-102595: Document `PyObject_Format` c-api function

    f0059bd
  4. miss-islington
    added 5 commits that reference this issue on Mar 21, 2023

    gh-102595: Document `PyObject_Format` c-api function (GH-102596)

    910a64e

    pythongh-102595: Document `PyObject_Format` c-api function (pythonGH-…

    3ccbe6a

    pythongh-102595: Document `PyObject_Format` c-api function (pythonGH-…

    eeaac1b

    [3.11] gh-102595: Document `PyObject_Format` c-api function (GH-102596)…

    a7a373e

    gh-102595: Document `PyObject_Format` c-api function (GH-102596)

    eaafea8

  5. encukou commented on Mar 22, 2023

    @encukou
    encukou
    on Mar 22, 2023
    Member

    Thank for the docs!

  6. encukou
    closed this as completedon Mar 22, 2023
  7. Fidget-Spinner
    added a commit that references this issue on Mar 27, 2023

    pythongh-102595: Document `PyObject_Format` c-api function (pythonGH-…

    05078fd
  8. warsaw
    added a commit that references this issue on Apr 11, 2023

    pythongh-102595: Document `PyObject_Format` c-api function (pythonGH-…

    973798f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirtype-featureA feature request or enhancement

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions