InsightSoftwareConsortium / InsightSoftwareConsortium/ITKSphinxExamples

Increase consistency in `src/Developer` files

Abierto
#318 2 comentarios 0 reacciones 1 asignado Reclamado por @ritishkhichi Ver en GitHub
Good first issue type:Bug type:Style
Lenguaje dominante
Jupyter Notebook
Estrellas
59
Forks
70
Merge medio
1 d 15 h
PR fusionados (30 d)
12

Descripción

The files in [src/Developer](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/tree/master/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 https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/pull/316#issuecomment-999242969.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.