-
Notifications
You must be signed in to change notification settings - Fork 358
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.
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
Docstrings for PyMaterialXCore classes. #2051
Open
StefanHabel
wants to merge
4
commits into
AcademySoftwareFoundation:main
Choose a base branch
from
StefanHabel:#342-PyMaterialXCore-class-docstrings
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Docstrings for PyMaterialXCore classes. #2051
StefanHabel
wants to merge
4
commits into
AcademySoftwareFoundation:main
from
StefanHabel:#342-PyMaterialXCore-class-docstrings
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
StefanHabel
force-pushed
the
#342-PyMaterialXCore-class-docstrings
branch
from
October 8, 2024 03:24
1100bf0
to
8df85a2
Compare
StefanHabel
commented
Oct 8, 2024
Mostly copied from corresponding C++ header files, but using backticks to automatically link to relevant sections in the Python API documentation, e.g. `Document` to link to `PyMaterialXCore.Document.html`. Using `mod.attr("<name>").doc() = ...` syntax so that this patch only adds new lines, rather than modifying existing lines. Using `:see:` fields to link to the corresponding C++ API docs page. Demo of generated HTML page available here: https://stefanhabel.github.io/generated/PyMaterialXCore.html Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
… docstrings. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
StefanHabel
force-pushed
the
#342-PyMaterialXCore-class-docstrings
branch
from
October 13, 2024 19:23
8df85a2
to
056a7ef
Compare
StefanHabel
added a commit
to StefanHabel/MaterialX
that referenced
this pull request
Oct 13, 2024
Similar to AcademySoftwareFoundation#2051 and AcademySoftwareFoundation#2061. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
StefanHabel
added a commit
to StefanHabel/MaterialX
that referenced
this pull request
Oct 13, 2024
Similar to AcademySoftwareFoundation#2051 and AcademySoftwareFoundation#2061 and AcademySoftwareFoundation#2063. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
StefanHabel
added a commit
to StefanHabel/MaterialX
that referenced
this pull request
Oct 13, 2024
Similar to AcademySoftwareFoundation#2051, AcademySoftwareFoundation#2061, AcademySoftwareFoundation#2063, and AcademySoftwareFoundation#2064. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
StefanHabel
added a commit
to StefanHabel/MaterialX
that referenced
this pull request
Oct 14, 2024
Similar to AcademySoftwareFoundation#2051, AcademySoftwareFoundation#2061, AcademySoftwareFoundation#2063, AcademySoftwareFoundation#2064, and AcademySoftwareFoundation#2065. Also fixing a couple of typos in Metal header files. Split from AcademySoftwareFoundation#1567. Update AcademySoftwareFoundation#342. Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
This was referenced Oct 14, 2024
StefanHabel
added a commit
to StefanHabel/StefanHabel.github.io
that referenced
this pull request
Oct 14, 2024
…s merged in. - AcademySoftwareFoundation/MaterialX#2038 - AcademySoftwareFoundation/MaterialX#2051 - AcademySoftwareFoundation/MaterialX#2061 - AcademySoftwareFoundation/MaterialX#2063 - AcademySoftwareFoundation/MaterialX#2064 - AcademySoftwareFoundation/MaterialX#2065 - AcademySoftwareFoundation/MaterialX#2066 Signed-off-by: Stefan Habel <19556655+StefanHabel@users.noreply.github.com>
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.
Mostly copied from corresponding C++ header files, but using backticks to automatically link to relevant sections in the Python API documentation, e.g.
Document
to link toPyMaterialXCore.Document.html
.Using
mod.attr("<name>").doc() = ...
syntax so that this patch only adds new lines, rather than modifying existing lines.Using
:see:
fields to link to corresponding C++ API docs pages.The docstrings can be retrieved using
help()
, e.g.$ python3 -c 'import PyMaterialXCore; help(PyMaterialXCore.NodeDef)'
Demo of generated HTML page available here:
https://stefanhabel.github.io/generated/PyMaterialXCore.html
Here's how the above docstring of the
NodeDef
class appears in the Python API documentation:https://stefanhabel.github.io/generated/PyMaterialXCore.NodeDef.html
Split from #1567.
Update #342.