Skip to content
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

DOCS: Correct variation_type data type in parametric setup documentation #5483

Merged
merged 2 commits into from
Nov 27, 2024

Conversation

jvela018
Copy link
Contributor

@jvela018 jvela018 commented Nov 27, 2024

Description

The functions add() and add_variation() within the ParametricSetup and SetupParam classes expect to be overloaded with variation_type variable of type str. However, initially it was int or float. This generated a warning when passing this argument as shown in the image below

image

The change in the docstring removes these warnings

image

Issue linked

No issue linked to this

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

@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.68%. Comparing base (3a4b738) to head (c224ab3).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5483   +/-   ##
=======================================
  Coverage   84.68%   84.68%           
=======================================
  Files         143      143           
  Lines       60110    60110           
=======================================
+ Hits        50903    50905    +2     
+ Misses       9207     9205    -2     

Copy link
Member

@Samuelopez-ansys Samuelopez-ansys left a comment

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 merged commit 076463a into main Nov 27, 2024
43 checks passed
@Samuelopez-ansys Samuelopez-ansys deleted the jv-doc branch November 27, 2024 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants