Merge pull request #701 from nexusformat/datatype-consistency-307

Clarify documentation to fix #307
nexusformat · Jan 23, 2020 · bb6be52 · bb6be52
2 parents 3331a31 + d888548
commit bb6be52
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 16 deletions.
diff --git a/manual/source/datarules.rst b/manual/source/datarules.rst
@@ -44,7 +44,7 @@ described by the following :index:`rules <rules; naming>`:
 
    .. _RegExpName:
 
-   .. rubric:: Regular expression pattern for NXDL group and field names
+   .. rubric:: Regular expression pattern for NeXus group and field names
 
    It is recommended that all group and field names 
    contain only these characters:

diff --git a/manual/source/nxdl-types.rst b/manual/source/nxdl-types.rst
@@ -1,17 +1,17 @@
-===================================
-NXDL: Data Types and Units
-===================================
+==========================
+NXDL Field Types and Units
+==========================
 
 .. index::
     see: type; data type
     ! single: data type
 
 .. _nxdl-types:
 
-Data Types allowed in NXDL specifications
-#########################################
+Field Types allowed in NXDL specifications
+##########################################
 
-Data types for use in NXDL
+Field types for use in NXDL
 describe the expected type of data for a NeXus field. These terms are very
 broad. More specific terms are used in actual NeXus data files that describe
 size and array dimensions. In addition to the types in the following table, the

diff --git a/nxdl.xsd b/nxdl.xsd
@@ -922,7 +922,7 @@
 					Type of the attribute.
 					For ``group`` specifications, the class name.
 					For ``field`` or ``attribute`` specifications, 
-					the NXDL data type.
+					the NXDL field type.
 				</xs:documentation>
 			</xs:annotation>
 		</xs:attribute>

diff --git a/utils/nxdl_desc2rst.py b/utils/nxdl_desc2rst.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 '''
-Read the the NeXus NXDL types specification and find
+Read the NXDL field types specification and find
 all the valid data types.  Write a restructured
 text (.rst) document for use in the NeXus manual in 
 the NXDL chapter.
@@ -137,9 +137,9 @@
                  }
 
 ELEMENT_PREAMBLE = '''
-===============================
-NXDL Elements and Data Types
-===============================
+=============================
+NXDL Elements and Field Types
+=============================
 
 The documentation in this section has been obtained directly 
 from the NXDL Schema file:  *nxdl.xsd*.
@@ -168,18 +168,18 @@
 .. _NXDL.elements:
 
 NXDL Elements
-=================
+=============
 
     '''
 
 DATATYPE_PREAMBLE = '''
 
 .. _NXDL.data.types.internal:
 
-NXDL Data Types (internal)
-============================
+NXDL Field Types (internal)
+===========================
 
-Data types that define the NXDL language are described here.
+Field types that define the NXDL language are described here.
 These data types are defined in the XSD Schema (``nxdl.xsd``)
 and are used in various parts of the Schema to define common structures
 or to simplify a complicated entry.  While the data types are not intended for