Adding a docstring for PyMaterialXFormat. #2040
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 a docstring in markdown format to the `PyMaterialXFormat` module. The docstring is defined in a macro named `PyMaterialXFormat_DOCSTRING` that uses 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 `PyMaterialXFormat_DOCSTRING` macro is placed in a separate header file named `__doc__.md.h` which lives side-by-side with the `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. Note that this PR also renames `readFromXmlFileBase()` to `readFromXmlFile()` allowing us to remove the alias from `python/MaterialX/main.py`. Split from AcademySoftwareFoundation#1567. Depends on AcademySoftwareFoundation#2038. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
|
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 a docstring in markdown format to the
PyMaterialXFormatmodule.The docstring is defined in a macro named
PyMaterialXFormat_DOCSTRINGthat uses 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
PyMaterialXFormat_DOCSTRINGmacro is placed in a separate header file named__doc__.md.hwhich lives side-by-side with thePyModule.cppfile in which it is included.Note that the docstrings for individual classes, methods, and functions are to be added in separate PRs.
Note that this PR also renames
readFromXmlFileBase()toreadFromXmlFile()allowing us to remove the alias frompython/MaterialX/main.py.Split from #1567.
Depends on #2038.
Update #342.