Generate IcePy docstrings from the stub - #6695
Draft
externl wants to merge 1 commit into
Draft
Conversation
The stub is the single source for IcePy docstrings: generateIcePyDocs.py renders it into the committed DocStrings.h, and CI verifies the header is current.
This was referenced Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
IcePy's docstrings exist in two hand-written copies — the C++ sources feeding Sphinx and
help(), and the stub feeding pyright and IDEs. This makes the stub the single source and derives the other copy.scripts/generateIcePyDocs.pyrenders every stub declaration — signature lines, prose, getset andtp_docstrings — into the committedpython/modules/IcePy/DocStrings.h, which the C++ sources reference.--check; editing the stub and regenerating is the whole doc-editing workflow.tp_docplaceholder forIcePy.ExecutorCall.The stub docstrings for the module-level functions come from #6609.