From 3821e105e29973e3d149dd3b452887d61b692a31 Mon Sep 17 00:00:00 2001 From: Peter Chang Date: Tue, 21 Jan 2020 18:31:05 -0600 Subject: [PATCH 1/3] Clarify documentation to fix #307 To distinguish between types used in NXDL schema and the data types used by NeXus specifications, the former is now called NXDL field types. --- manual/source/datarules.rst | 2 +- manual/source/nxdl-types.rst | 6 +++--- nxdl.xsd | 2 +- utils/nxdl_desc2rst.py | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/manual/source/datarules.rst b/manual/source/datarules.rst index 4a2e54c3c4..92e8fb42b0 100644 --- a/manual/source/datarules.rst +++ b/manual/source/datarules.rst @@ -44,7 +44,7 @@ described by the following :index:`rules `: .. _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 index b4e95c441f..585f69798a 100644 --- a/manual/source/nxdl-types.rst +++ b/manual/source/nxdl-types.rst @@ -1,5 +1,5 @@ =================================== -NXDL: Data Types and Units +NXDL Field Types and Units =================================== .. index:: @@ -8,10 +8,10 @@ NXDL: Data Types and Units .. _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 index d45c410daa..478a122a57 100644 --- a/nxdl.xsd +++ b/nxdl.xsd @@ -923,7 +923,7 @@ Type of the attribute. For ``group`` specifications, the class name. For ``field`` or ``attribute`` specifications, - the NXDL data type. + the NXDL field type. diff --git a/utils/nxdl_desc2rst.py b/utils/nxdl_desc2rst.py index a98a6f3622..6cd2846dbe 100755 --- 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. @@ -138,7 +138,7 @@ ELEMENT_PREAMBLE = ''' =============================== -NXDL Elements and Data Types +NXDL Elements and Field Types =============================== The documentation in this section has been obtained directly @@ -176,10 +176,10 @@ .. _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 From af7df8a5a3809036a8955395d6a31f932535328d Mon Sep 17 00:00:00 2001 From: Peter Chang Date: Thu, 23 Jan 2020 13:28:01 -0600 Subject: [PATCH 2/3] Ensure heading markdown lines up --- manual/source/nxdl-types.rst | 2 +- utils/nxdl_desc2rst.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/manual/source/nxdl-types.rst b/manual/source/nxdl-types.rst index 585f69798a..ccaa9f991f 100644 --- a/manual/source/nxdl-types.rst +++ b/manual/source/nxdl-types.rst @@ -9,7 +9,7 @@ NXDL Field Types and Units .. _nxdl-types: Field Types allowed in NXDL specifications -######################################### +########################################## Field types for use in NXDL describe the expected type of data for a NeXus field. These terms are very diff --git a/utils/nxdl_desc2rst.py b/utils/nxdl_desc2rst.py index 6cd2846dbe..a7f2604cfb 100755 --- a/utils/nxdl_desc2rst.py +++ b/utils/nxdl_desc2rst.py @@ -137,9 +137,9 @@ } ELEMENT_PREAMBLE = ''' -=============================== +============================= NXDL Elements and Field Types -=============================== +============================= The documentation in this section has been obtained directly from the NXDL Schema file: *nxdl.xsd*. @@ -168,7 +168,7 @@ .. _NXDL.elements: NXDL Elements -================= +============= ''' @@ -177,7 +177,7 @@ .. _NXDL.data.types.internal: NXDL Field Types (internal) -============================ +=========================== Field types that define the NXDL language are described here. These data types are defined in the XSD Schema (``nxdl.xsd``) From d888548b6911c988c9e0ea43591e4a98c88b6558 Mon Sep 17 00:00:00 2001 From: Peter Chang Date: Thu, 23 Jan 2020 13:31:49 -0600 Subject: [PATCH 3/3] Final markup alignment --- manual/source/nxdl-types.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manual/source/nxdl-types.rst b/manual/source/nxdl-types.rst index ccaa9f991f..f15352aa29 100644 --- a/manual/source/nxdl-types.rst +++ b/manual/source/nxdl-types.rst @@ -1,6 +1,6 @@ -=================================== +========================== NXDL Field Types and Units -=================================== +========================== .. index:: see: type; data type