core icon indicating copy to clipboard operation
core copied to clipboard

feat: Rename `TargettedPixelGroup` to `TargetedPixelGroup`

Open munechika-koyo opened this issue 2 months ago • 3 comments

Key changes:

  • Rename TargettedPixelGroup to TargetedPixelGroup and add deprecation warnings.

  • Remove unnecessary blank lines for improved code formatting.

munechika-koyo avatar Oct 16 '25 09:10 munechika-koyo

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 avatar Oct 17 '25 08:10 skuba31

@skuba31 Thanks for your feedback! I specified the version number when we will remove the deprecated API.

munechika-koyo avatar Oct 17 '25 09:10 munechika-koyo

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 Targeted spelling? For subclasses of Raysect Targeted* classes these may be present, in which case you should also add aliased methods in the compatibility class.

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.

jacklovell avatar Oct 17 '25 14:10 jacklovell

Also, could you please make an issue about removing the deprecated TargettedPixelGroup when we move to Cherab 2.0 version? I created a new milestone for the version 2.0, please link it with the issue so we don't forget all the deprecated code to be removed.

Mateasek avatar Nov 26 '25 09:11 Mateasek

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.

Mateasek avatar Nov 27 '25 11:11 Mateasek