Skip to content

Conversation

@dan-wilton
Copy link

@dan-wilton dan-wilton commented Mar 23, 2025

This is my first commit(s) and PR to cpython, thought I'd pick up some docs updates first 📝😄

Issue: #90120


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

@ghost
Copy link

ghost commented Mar 23, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

ZeroIntensity
ZeroIntensity previously approved these changes Mar 27, 2025
@hugovk hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
Comment on lines +657 to +658
*STRINGLIB_TYPE_NAME* to *module*. The string *value* must be
``NULL``-terminated and UTF-8 encoded.
Copy link
Member

Choose a reason for hiding this comment

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

value is not a variable we know about here. It makes sense for PyModule_AddStringConstant because there's a value parameter.

Instead, let's do something like this:

Suggested change
*STRINGLIB_TYPE_NAME* to *module*. The string *value* must be
``NULL``-terminated and UTF-8 encoded.
*STRINGLIB_TYPE_NAME* to *module*. The contents of the macro must be
``NULL``-terminated and UTF-8 encoded.

I think it would also make more sense to move that sentence to before "For example".

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 needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news topic-C-API

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants