Adding docstrings for PyMaterialXGen*. #2041
Closed
Conversation
This file contains 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
This PR adds docstrings in markdown format to the following modules: - `PyMaterialXGenGlsl` - `PyMaterialXGenMdl` - `PyMaterialXGenMsl` - `PyMaterialXGenOsl` - `PyMaterialXGenShader` The docstrings are defined in macros named `PyMaterialXGen*_DOCSTRING` that use the new `PYMATERIALX_DOCSTRING` macro that is introduced in AcademySoftwareFoundation#2038 to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after the `R"docstring(` marker. The `PyMaterialXGen*_DOCSTRING` macros are placed in separate header files named `__doc__.md.h` which live side-by-side with their corresponding `PyModule.cpp` file in which it is included. Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <[email protected]>
|
Abandoning this PR, following discussion in #2039 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds docstrings in markdown format to the following modules:
PyMaterialXGenGlslPyMaterialXGenMdlPyMaterialXGenMslPyMaterialXGenOslPyMaterialXGenShaderThe docstrings are defined in macros named
PyMaterialXGen*_DOCSTRINGthat use the newPYMATERIALX_DOCSTRINGmacro that is introduced in #2038 to allow us to place the first and last lines in lines by themselves, rather than starting the docstring contents immediately after theR"docstring(marker.The
PyMaterialXGen*_DOCSTRINGmacros are placed in separate header files named__doc__.md.hwhich live side-by-side with their correspondingPyModule.cppfiles in which they are included.Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs.
Split from #1567.
Depends on #2038.
Update #342.