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

Increase consistency in src/Developer files #318

Open
jhlegarreta opened this issue Dec 28, 2021 · 1 comment
Open

Increase consistency in src/Developer files #318

jhlegarreta opened this issue Dec 28, 2021 · 1 comment
Labels
Good first issue A good issue for community members new to contributing type:Bug Inconsistencies or issues which will cause an incorrect result under some or all circumstances type:Style Style changes: no logic impact (indentation, comments, naming)

Comments

@jhlegarreta
Copy link
Member

The files in src/Developer seem to hold some inconsistencies:

  • The classes in the ImageFilterX.* and ImageFilterY.* files should probably be renamed to ImageFilterX and ImageFilterY. They currently define a class names ImageFilter, which is also defined in the ImageFilter.* file.
  • All files might need to be renamed to have a leading itk*. There are actually some inconsistencies in classes with supposedly similar patterns, e.g. itkImageFilterMultipleInputs.* vs ImageFilterMultipleOutputs.*` -not sure if intended). This will need to be accompanied with the appropriate changes to the include guards.

It is probably a good idea to know if these were intended, and if yes, make it clear the reason, as it does not seem intuitive.

Maybe the notices Warning Fix Errors Example contains errors needed to be fixed for proper output. that are visible in the concerned pages raises from these observations, e.g.
https://itk.org/ITKExamples/src/Core/Common/ProduceImageProgrammatically/Documentation.html

Following #316 (comment).

@jhlegarreta jhlegarreta added type:Bug Inconsistencies or issues which will cause an incorrect result under some or all circumstances Good first issue A good issue for community members new to contributing type:Style Style changes: no logic impact (indentation, comments, naming) labels Dec 28, 2021
@dzenanz
Copy link
Member

dzenanz commented Dec 28, 2021

I don't think the inconsistency is intentional. Those examples were contributed by various people, so inconsistency arises naturally. Fixing it would be good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue A good issue for community members new to contributing type:Bug Inconsistencies or issues which will cause an incorrect result under some or all circumstances type:Style Style changes: no logic impact (indentation, comments, naming)
Projects
None yet
Development

No branches or pull requests

2 participants