Skip to content

Commit 532ca00

Browse files
committed
DOC: Add details for running CreateNewExample.py
1 parent 66b8d2f commit 532ca00

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/Contribute/ContributeWithGit.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ binary tree (*/path/to/ITKSphinxExamples-build/Utilities*)::
6666
cd /path/to/ITKSphinxExamples-build/Utilities
6767
python ./CreateNewExample.py
6868

69+
The script will ask for an *example_name* and a *class_name*. The example_name
70+
would be *ComputeTumorIntensityVariation* for an example that answers the
71+
question "How do I compute tumor intensity variation?" The class_name
72+
indicates the itk class that is the focus of the example, such as
73+
*itk::Statistics::MaskedImageToHistogramFilter*.
74+
6975
*This script will generate *.cxx, *.py, and *.rst files to be modified.*
7076

7177
Note that the generated files are then located based on the group, module and

0 commit comments

Comments
 (0)