-
Notifications
You must be signed in to change notification settings - Fork 24
feat: Rename TargettedPixelGroup to TargetedPixelGroup
#487
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
feat: Rename TargettedPixelGroup to TargetedPixelGroup
#487
Conversation
munechika-koyo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should wait for #486 merged to run CI correctly.
|
I have only one minor point regarding the deprecation warning. Should an explicit version number be added to the message? And if so, should it be 2.0 or a different one? |
|
@skuba31 Thanks for your feedback! |
|
2.0 is the appropriate place to remove deprecations, agreed. Have you checked if there are any public attributes or methods in classes which use the new I wouldn't want to go too far down this rabbit hole though. We can do what we can to provide backwards compatibility, but users will find stuff breaks anyway if they use any of the Raysect classes directly so it'll never be a completely clean switch. |
Mateasek
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @munechika-koyo , thanks for taking care of the renaming and backwards compatibility.
Could you please add the TargetedPixelGroup to the documentation? I know it is almost a duplicate of the TargettedPixelGroup docstring, but since you added the deprecation warning, I think it should be visible from the documentation that there is a replacement class available.
|
Also, could you please make an issue about removing the deprecated |
|
Thank you for adding the record into documentation and for creating the issue. Also, thank you very much for the PR @munechika-koyo, I'm merging this into development. |
Key changes:
Rename
TargettedPixelGrouptoTargetedPixelGroupand add deprecation warnings.Remove unnecessary blank lines for improved code formatting.