Skip to content

DOCS: Fix monitor documentation - #6457

Merged
Samuelopez-ansys merged 8 commits into
mainfrom
fix/monitor_documentation
Jul 24, 2025
Merged

DOCS: Fix monitor documentation#6457
Samuelopez-ansys merged 8 commits into
mainfrom
fix/monitor_documentation

Conversation

@lorenzovecchietti

Copy link
Copy Markdown
Contributor

Description

Some monitor classes were not included in the documentation. Also, the min_aedt_version decorator seems to be breaking Sphinx ability to retrieve the doc strings to add to the documentation.

@lorenzovecchietti
lorenzovecchietti requested a review from a team as a code owner July 23, 2025 10:22
@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 bug Something isn't working label Jul 23, 2025
@lorenzovecchietti lorenzovecchietti changed the title Fix monitor documentation DOCS: Fix monitor documentation Jul 23, 2025
@codecov

codecov Bot commented Jul 23, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.43%. Comparing base (02db1f2) to head (bd793d4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6457   +/-   ##
=======================================
  Coverage   82.43%   82.43%           
=======================================
  Files         230      230           
  Lines       73678    73680    +2     
=======================================
+ Hits        60738    60740    +2     
  Misses      12940    12940           
🚀 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.

SMoraisAnsys
SMoraisAnsys previously approved these changes Jul 23, 2025

@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.

LGTM, thanks @lorenzovecchietti
I left a minor comment.

Comment thread src/ansys/aedt/core/internal/checks.py
Comment thread src/ansys/aedt/core/internal/checks.py
Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>

@Samuelopez-ansys Samuelopez-ansys left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Samuelopez-ansys
Samuelopez-ansys enabled auto-merge (squash) July 23, 2025 18:05
@Samuelopez-ansys
Samuelopez-ansys merged commit 6a7d967 into main Jul 24, 2025
38 checks passed
@Samuelopez-ansys
Samuelopez-ansys deleted the fix/monitor_documentation branch July 24, 2025 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants