Skip to content

Py_buffer.format declaration inconsistent with the docs #119467

Closed
Closed
Py_buffer.format declaration inconsistent with the docs#119467
Labels
3.12only security fixes3.13only security fixes3.14bugs and security fixesdocsDocumentation in the Doc direasytopic-C-APItype-bugAn unexpected behavior, bug, or error

Description

@philthompson10
philthompson10
opened on May 23, 2024

Bug report

Bug description:

The declaration of the format field of the Py_buffer structure is char * but the documentation states it is const char *.

IMHO the declaration should be changed to match the docs.

CPython versions tested on:

3.8, 3.9, 3.10, 3.11, 3.12, 3.13

Operating systems tested on:

Linux, macOS, Windows

Linked PRs

Activity

  1. philthompson10
    added
    type-bugAn unexpected behavior, bug, or error
    on May 23, 2024
  2. Eclips4
    added
    docsDocumentation in the Doc dir
    topic-C-API
    on May 23, 2024

  3. Eclips4 commented on May 23, 2024

    @Eclips4
    Eclips4
    on May 23, 2024
    Member

    Hello!
    Would you like to send a PR with fix? :)

  4. Eclips4
    added
    3.12only security fixes
    3.13only security fixes
    3.14bugs and security fixes
    easy
    on May 23, 2024

  5. philthompson10 commented on May 23, 2024

    @philthompson10
    philthompson10
    on May 23, 2024
    Author

    I'd like to - may take a while...

  6. adiaholic
    added a commit that references this issue on May 23, 2024

    Fix Py_buffer.format type and correct documentation typo

    ab0f20f

  7. adiaholic commented on May 23, 2024

    @adiaholic
    adiaholic
    on May 23, 2024
    Contributor

    I have pushed a fix for this inconsistency. It would be great if @Eclips4 could review the changes and confirm if this resolves the issue.

    Feedback is highly appreciated!

  8. adiaholic
    added a commit that references this issue on May 23, 2024

    Fix Py_buffer.format type and correct documentation typo

    1facf3a
  9. kumaraditya303
    added a commit that references this issue on May 27, 2024

    gh-119467: Fix Py_buffer.format type and correct documentation typo (#…

    3b26cd8
  10. miss-islington
    added 2 commits that reference this issue on May 27, 2024

    pythongh-119467: Fix Py_buffer.format type and correct documentation …

    f8fab8b

    pythongh-119467: Fix Py_buffer.format type and correct documentation …

    713d85a
  11. kumaraditya303
    closed this as completedon May 27, 2024
  12. kumaraditya303
    added 2 commits that reference this issue on May 27, 2024

    [3.12] gh-119467: Fix Py_buffer.format type and correct documentation…

    8d7e54a

    [3.13] gh-119467: Fix Py_buffer.format type and correct documentation…

    f1302c1
  13. estyxx
    added a commit that references this issue on Jul 17, 2024

    pythongh-119467: Fix Py_buffer.format type and correct documentation …

    1fe7701
  14. cmaloney
    marked Py_buffer::format is implemented as char* instead of const char* #94916 as a duplicate of this issue on Nov 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12only security fixes3.13only security fixes3.14bugs and security fixesdocsDocumentation in the Doc direasytopic-C-APItype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions