Add the Returns section to the operator automatic docstring #1823
Conversation
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
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1823 +/- ##
==========================================
+ Coverage 88.08% 88.10% +0.02%
==========================================
Files 83 83
Lines 9951 9951
==========================================
+ Hits 8765 8767 +2
+ Misses 1186 1184 -2 |
Co-authored-by: PProfizi <PProfizi@users.noreply.github.com>
MichaelNale
approved these changes
Oct 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The
Returnssection of the docstring for operators was missing from themustachetemplate.This PR adds it and updates all operators so the operators' outputs are shown in the API reference with their description, sometimes crucial to the use of the operator (such as
metadata.mesh_property_providerwhere the type of the output depends on the input and is only described in the output pin description).