Skip to content

docs: add warning section for minimum version on methods #2062

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

Merged
merged 6 commits into from
Jun 23, 2025

Conversation

RobPasMue
Copy link
Member

Description

Adding information for minimum version on docstrings for APIs

Issue linked

Closes #2056

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 unit tests.
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved to the PR if any.
  • I have assigned this PR to myself.
  • I have added the minimum version decorator to any new backend method implemented.
  • I have made sure that the title of my PR follows Conventional commits style (e.g. feat: extrude circle to cylinder)

@RobPasMue RobPasMue self-assigned this Jun 20, 2025
@RobPasMue RobPasMue requested a review from a team as a code owner June 20, 2025 19:25
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 20, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 20, 2025
Copy link

codecov bot commented Jun 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.60%. Comparing base (9ed72b9) to head (fc20142).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2062   +/-   ##
=======================================
  Coverage   92.60%   92.60%           
=======================================
  Files         136      136           
  Lines        9810     9810           
=======================================
  Hits         9085     9085           
  Misses        725      725           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 20, 2025
MaxJPRey
MaxJPRey previously approved these changes Jun 21, 2025
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

LGTM

@RobPasMue RobPasMue changed the title docs: add notes section for minimum version on methods docs: add warning section for minimum version on methods Jun 23, 2025
@RobPasMue
Copy link
Member Author

Moving it to warning rather than notes

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 23, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 23, 2025
@RobPasMue
Copy link
Member Author

I also tried to implement it as a Sphinx hook but the problem is related to the way Sphinx Autoapi parses the docstrings

@RobPasMue RobPasMue merged commit 33a3df2 into main Jun 23, 2025
44 checks passed
@RobPasMue RobPasMue deleted the docs/min-version-docstring branch June 23, 2025 08:07
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.

Clearly mark features that require unreleased Ansys versions in the documentation
3 participants