changes made as per Pete's comments regarding formatting and validIte…

…mLink
nexusformat · Jun 14, 2022 · b5e27a1 · b5e27a1
1 parent 727a597
commit b5e27a1
Showing 1 changed file with 13 additions and 16 deletions.
diff --git a/manual/source/defs_intro.rst b/manual/source/defs_intro.rst
@@ -62,23 +62,20 @@ array dimensions. For reasons of avoiding naming collisions and to facilitate
 readbility and comprehension for those whom are new to an NXDL file, the following
 guidelines are strongly encouraged:
 
- * all symbols used in the application definition are defined in a single ``Symbols`` table
- * the name of a symbol uses camel case without any white space or underscores 
-
- examples: 
- **nP**: Total number of scan points
-
- **nE**: Number of photon energies scanned
-
- **nFrames**: Number of frames
-
- **nY**: Number of pixels in Y direction
-
- **detectorRank**: Rank of data array provided by the detector for a single measurement
+* all symbols used in the application definition are defined in a single ``Symbols`` table
+* the :ref:`name <validItemName>` of a symbol uses camel case without any white space or underscores 
+ examples: 
+ **nP**: Total number of scan points
+
+ **nE**: Number of photon energies scanned
+
+ **nFrames**: Number of frames
+
+ **detectorRank**: Rank of data array provided by the detector for a single measurement
+
+* the ``Symbols`` table appears early in the .nxdl file above the ``NXentry`` group
 
- * the ``Symbols`` table appears early in the .nxdl file above the ``NXentry`` group
-
- example from `NXtomo.nxdl.xml <https://github.com/nexusformat/definitions/blob/main/applications/NXtomo.nxdl.xml>`_
+ example from `NXtomo.nxdl.xml <https://github.com/nexusformat/definitions/blob/main/applications/NXtomo.nxdl.xml>`_
 
 .. code-block:: xml 
  :linenos: