Skip to content

DOCS: Add docstring to some classes in constants.py#6099

Merged
Samuelopez-ansys merged 6 commits into
mainfrom
doc/update-axis-docstring
May 5, 2025
Merged

DOCS: Add docstring to some classes in constants.py#6099
Samuelopez-ansys merged 6 commits into
mainfrom
doc/update-axis-docstring

Conversation

@Devin-Crawford

Copy link
Copy Markdown
Contributor

Update documentation for AXIS and a few other
constant CLASSES.

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have agreed with the Contributor License Agreement (CLA).

Update documentation for AXIS and a few other
constant CLASSES.
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 1, 2025
@codecov

codecov Bot commented May 1, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.66%. Comparing base (5fc28b4) to head (352ef5f).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6099   +/-   ##
=======================================
  Coverage   85.65%   85.66%           
=======================================
  Files         166      166           
  Lines       62786    62786           
=======================================
+ Hits        53781    53787    +6     
+ Misses       9005     8999    -6     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread src/ansys/aedt/core/generic/constants.py Outdated

@SMoraisAnsys SMoraisAnsys left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just an open question, could we use pyrhon enums here instead of this custom enum ?

Devin and others added 3 commits May 1, 2025 12:36
@Devin-Crawford

Copy link
Copy Markdown
Contributor Author

Just an open question, could we use pyrhon enums here instead of this custom enum ?

I defer to the experts on this question.

@Samuelopez-ansys Samuelopez-ansys merged commit 5caf90e into main May 5, 2025
1 check passed
@Samuelopez-ansys Samuelopez-ansys deleted the doc/update-axis-docstring branch May 5, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants