Skip to content

Conversation

@StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Apr 23, 2025

See: #53185 (comment)

Request @vstinner (I can send the other PR's but I wanted to verify you still want to do this :-)


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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Apr 23, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Apr 23, 2025
@StanFromIreland StanFromIreland changed the title Use C type names in c-api/args.rst gh-53185: Use C type names in c-api/args.rst Apr 23, 2025
for a writable buffer, or whether another thread can mutate the data).

``s`` (:class:`str`) [const char \*]
``"s"`` (:c:type:`PyUnicodeObject\*`) [:c:type:`const char\*`]
Copy link
Member

Choose a reason for hiding this comment

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

There are warnings if you look at the Files Changes tab. Examples:

  • Unparseable C cross-reference: 'PyUnicodeObject*'
  • Unparseable C cross-reference: 'const char*'

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah yes, a lot has changed since your patch

@vstinner
Copy link
Member

Hum, for this documentation, I would prefer to keep Python names. IMO it's more common to see Python names than PyUnicodeObject*.

@serhiy-storchaka: Do you have an opinion on this change?

@serhiy-storchaka
Copy link
Member

I agree with @vstinner. These are references to types from Python side, they should use Python names.

@StanFromIreland
Copy link
Member Author

@vstinner The issue can be closed then if this will not be done

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

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants