Skip to content

Rename argument 'major_raidus' as 'major_radius'. #667

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 1 commit into from
Dec 21, 2021
Merged

Conversation

MaxJPRey
Copy link
Collaborator

Fix issue #662 .
Rename argument 'major_raidus' as 'major_radius' in the method create_ellipse() in the Primitives3D module.

@MaxJPRey MaxJPRey requested a review from PipKat December 20, 2021 15:30
@@ -562,7 +562,7 @@ def create_circle(self, cs_plane, position, radius, numSides=0, is_covered=True,
return self._create_object(new_object_name)

@aedt_exception_handler
def create_ellipse(self, cs_plane, position, major_raidus, ratio, is_covered=True, name=None, matname=None):
def create_ellipse(self, cs_plane, position, major_radius, ratio, is_covered=True, name=None, matname=None):
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@maxcapodi78 I don't know if we should add a deprecation warning as it is an argument name and not the method name that was changed. Let say that one customer uses named arguments in his script with something like:
create_ellipse(, "XY", [0., 0.,0.], major_raidus = 3.2, ratio = 0.8, is_covered=True, name=None, matname=None)
Then his script will fail.
What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

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

it's a clear spelling error. I don't think it's needed deprecation warning as soon as it's documented

Copy link
Collaborator

@maxcapodi78 maxcapodi78 left a comment

Choose a reason for hiding this comment

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

LGTM

@MaxJPRey MaxJPRey merged commit 0807ad4 into main Dec 21, 2021
@MaxJPRey MaxJPRey deleted the fix/issue_662 branch December 21, 2021 09:49
@MaxJPRey MaxJPRey linked an issue Dec 21, 2021 that may be closed by this pull request
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.

Misspelling argument in create_ellipse() in Primitives3D.
2 participants