Updated documentation with Utility Functions #229
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
New 'Utility functions' descriptions for previously hidden functions. Added Adaptive geometry and utility functions to the API reference page.
JackB-Ansys
requested review from
matthewAnsys,
jgsdavies and
ravi-ansys
as code owners
github-actions
bot
added
the
documentation
|
Closes #89 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #229 +/- ##
=======================================
Coverage 85.77% 85.77%
=======================================
Files 19 19
Lines 1575 1575
=======================================
Hits 1351 1351
Misses 224 224 |
jgsdavies
requested changes
Dec 5, 2023
jgsdavies
reviewed
Dec 5, 2023
ravi-ansys
previously approved these changes
Jan 12, 2024
# Conflicts: # doc/source/methods/geometry_functions.rst # doc/source/methods/index.rst
PipKat
reviewed
May 7, 2024
PipKat
reviewed
May 7, 2024
PipKat
reviewed
May 7, 2024
PipKat
reviewed
May 7, 2024
PipKat
reviewed
May 7, 2024
Comment on lines
+53
to
+55
| A class/exception type used for obtaining and handling errors from Motor-CAD. | ||
| For descriptions, see | ||
| :ref:`MotorCAD_errors`. |
There was a problem hiding this comment.
Suggested change
| A class/exception type used for obtaining and handling errors from Motor-CAD. | |
| For descriptions, see | |
| :ref:`MotorCAD_errors`. | |
| A class/exception type is used to obtain and handle errors from Motor-CAD. | |
| For more information, see | |
| :ref:`MotorCAD_errors`. |
The first line must be a complete sentence, not a fragment.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #229 +/- ##
=======================================
Coverage 84.36% 84.36%
=======================================
Files 20 20
Lines 1931 1931
=======================================
Hits 1629 1629
Misses 302 302 |
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
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.
New 'Utility functions' descriptions for previously hidden functions.
Also added Adaptive geometry and utility functions to the API reference page.