Skip to content

Commit 66bfc0a

Browse files
committed
STYLE: Use definition list for markup of parameters
1 parent ec2850f commit 66bfc0a

File tree

1 file changed

+30
-28
lines changed

1 file changed

+30
-28
lines changed

README.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,45 @@ The following will get an external module started in a new repository:
2525
Reasonable defaults will be provided for all of the parameters. The
2626
parameters are:
2727

28-
*full\_name*
29-
Your full name.
28+
<dl>
29+
<dt>full_name</dt>
30+
<dd>Your full name.</dd>
3031

31-
*email*
32-
Your email.
32+
<dt>email</dt>
33+
<dd>Your email.</dd>
3334

34-
*project\_name*
35-
This is a name for the project, which is *ITK* followed by the module
36-
name, by convention. Examples include *ITKIsotropicWavelets* or
37-
*ITKBoneMorphometry*.
35+
<dt>project_name</dt>
36+
<dd>This is a name for the project, which is <i>ITK</i> followed by the module
37+
name, by convention. Examples include <i>ITKIsotropicWavelets</i> or
38+
<i>ITKBoneMorphometry</i>.<dd>
3839

39-
*module\_name*
40-
This is the name of the module. Since this is an external module, it
41-
does not start with the *ITK* prefix. It is in CamelCase, by convention.
42-
Examples include *IsotropicWavelets* and *BoneMorphometry*.
40+
<dt>module_name</dt>
41+
<dd>This is the name of the module. Since this is an external module, it
42+
does not start with the <i>ITK</i> prefix. It is in CamelCase, by convention.
43+
Examples include <i>IsotropicWavelets</i> and <i>BoneMorphometry</i>.<dd>
4344

44-
*filter\_name*
45-
The skeleton of an `itk::ImageToImageFilter` will be created by default.
45+
<dt>filter_name</dt>
46+
<dd>The skeleton of an <code>itk::ImageToImageFilter</code> will be created by default.
4647
Optionally specify this value, if you will be adding an
47-
`itk::ImageToImageFilter` to your module.
48+
<code>itk::ImageToImageFilter</code> to your module.</dt>
4849

49-
*python\_package\_name*
50-
This is the name of the Python package that will be created from the
51-
module. By convention, this is *itk-\<project\_name in lower case\>*.
52-
For example, *itk-isotropicwavelets* or *itk-bonemorphometry*.
50+
<dt>python_package_name</dt>
51+
<dd>This is the name of the Python package that will be created from the
52+
module. By convention, this is <i>itk-<project_name in lower case></i>
53+
For example, <i>itk-isotropicwavelets</i> or <i>itk-bonemorphometry</i>.</dd>
5354

54-
*download\_url*
55-
This is the download url added to the Python package metadata. This can
56-
be the GitHub repository URL.
55+
<dt>download_url</dt>
56+
<dd>This is the download url added to the Python package metadata. This can
57+
be the GitHub repository URL.</dd>
5758

58-
*project\_short\_description*
59-
A short description to use in the project README, module Doxygen
60-
documentation, and Python package documentation.
59+
<dt>project_short_description</dt>
60+
<dd>A short description to use in the project README, module Doxygen
61+
documentation, and Python package documentation.</dd>
6162

62-
*project\_long\_description*
63-
A long description to use in the project README, module Doxygen
64-
documentation, and Python package documentation.
63+
<dt>project_long_description</dt>
64+
<dd>A long description to use in the project README, module Doxygen
65+
documentation, and Python package documentation.</dd>
66+
</dl>
6567

6668
The output of the cookiecutter is a buildable ITK external module with
6769
example classes. Remove or replace the classes with your new classes.

0 commit comments

Comments
 (0)