Skip to content

gh-124182: Explain naming rules for struct sequence types #124335

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

Merged
merged 3 commits into from
Oct 7, 2024
Merged

gh-124182: Explain naming rules for struct sequence types #124335

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
544aeb2
Explain naming rules for struct sequence types
ffelixg Sep 23, 2024
95045c6
Update documentation for struct sequence name
ffelixg Sep 23, 2024
64cbd59
Specifically mention module name
ffelixg Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Doc/c-api/tuple.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,13 @@ type.

.. c:member:: const char *name

Name of the struct sequence type.
Pointer to a NUL-terminated string containing the fully qualified name of the
type. For types that are accessible as module globals, the string should be
Copy link
Member

Choose a reason for hiding this comment

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

I suggest to replace the whole paragraph with just:

"Fully qualified name of the type; null-terminated UTF-8 encoded."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fine with me. I think it would have been enough to put me on the right track when I ran into the issue.

the full module name, followed by a dot, followed by the type name. If the
module is a submodule of a package, the full package name is part of the full
Copy link
Member

Choose a reason for hiding this comment

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

"If the module is a submodule (...)" IMO that's too much, you can remove it.

module name. For example, a type named :class:`!T` defined in module :mod:`!M`
in subpackage :mod:`!Q` in package :mod:`!P` should have the name ``"P.Q.M.T"``.
The name must include at least one dot.

.. c:member:: const char *doc

Expand Down
Loading