docs: document C header → .pyi docstring derivation#369
Open
hunterdsp wants to merge 1 commit into
Open
Conversation
Explains how jm extracts /** ... */ Doxygen comments from _core.h headers using regex (no Doxygen tool), converts @brief/@param/@return/@code tags to numpy-style docstrings, and embeds them in generated .pyi stubs. Covers: supported tags, before/after example (C comment → .pyi), how @code blocks become runnable CI doctests (pytest --doctest-glob='*.pyi'), the manifest-drift gate, and why the separate Doxygen XML pipeline is completely independent of .pyi generation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
docs/developers/docstring-derivation.mdexplaining the full pipeline from C/** ... */Doxygen comments → jm regex extraction → numpy-style.pyidocstringsWhat's covered
extract_doc_blocks()→parse_doxygen_block()→render_numpy_method_doc()→.pyi)@brief,@param,@return,@code/@endcode).pyiclass docstring)@codeblocks become runnablepytest --doctest-glob='*.pyi'CI testsjm status --check).pyigenerationTest plan
make docs-serve🤖 Generated with Claude Code