Fix documentation typos

maarten-ic · maarten-ic · commit a0c61d4460bc · 2023-05-17T11:39:03.000+02:00
diff --git a/conftest.py b/conftest.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 #
 # Set up pytest so that any mention of 'backend' as a test argument
 # gets run with all four backends.
diff --git a/docs/source/metadata.rst b/docs/source/metadata.rst
@@ -24,7 +24,7 @@ nodes.
 Get coordinate values
 '''''''''''''''''''''
 
-All data nodes and array of structures have a ``coordinates`` attribute. By
+Each data node and array of structures has a ``coordinates`` attribute. By
 indexing this attribute, you can retrieve the coordinate values for that
 dimension. For example, ``coordinates[2]`` attempts to retrieve the coordinate
 values for the third dimension of the data.
diff --git a/imaspy/__init__.py b/imaspy/__init__.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 
 from packaging.version import Version as V
 
diff --git a/imaspy/al_exception.py b/imaspy/al_exception.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 
 """ Exception specific for access layers"""
 
diff --git a/imaspy/backends/__init__.py b/imaspy/backends/__init__.py
@@ -1,2 +1,2 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
diff --git a/imaspy/backends/ual.py b/imaspy/backends/ual.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 import importlib
 import logging
 import os
diff --git a/imaspy/command/cli.py b/imaspy/command/cli.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Main CLI entry point """
 from importlib.metadata import version, PackageNotFoundError
 
diff --git a/imaspy/command/subcommands/ids.py b/imaspy/command/subcommands/ids.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """Command-line tools provided with IMASPy."""
 import argparse
 import logging
diff --git a/imaspy/context_store.py b/imaspy/context_store.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 
 import numpy as np
 
diff --git a/imaspy/dd_zip.py b/imaspy/dd_zip.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Extract DD versions from a zip file.
 
 The zip file contains files as
diff --git a/imaspy/examples/ids_dummy_class.py b/imaspy/examples/ids_dummy_class.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 import logging
 import os
 import sys
diff --git a/imaspy/examples/read_write_nbi.py b/imaspy/examples/read_write_nbi.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 import copy
 
 # NEEDED MODULES
diff --git a/imaspy/ids_coordinates.py b/imaspy/ids_coordinates.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """Logic for interpreting coordinates in an IDS
 """
 
diff --git a/imaspy/ids_data_type.py b/imaspy/ids_data_type.py
@@ -1,7 +1,6 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
-"""Logic for IDS data types.
-"""
+# You should have received the IMASPy LICENSE file with this project.
+
 from enum import Enum
 from typing import Tuple, Optional
 
diff --git a/imaspy/ids_defs.py b/imaspy/ids_defs.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Load IMASPy libs to provide constants
 """
 
diff --git a/imaspy/ids_metadata.py b/imaspy/ids_metadata.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Core of the IMASPy interpreted IDS metadata
 """
 from typing import Optional, Any, Dict
diff --git a/imaspy/ids_mixin.py b/imaspy/ids_mixin.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 
 import copy
 import logging
diff --git a/imaspy/ids_path.py b/imaspy/ids_path.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """Logic for interpreting paths to elements in an IDS
 """
 
diff --git a/imaspy/ids_primitive.py b/imaspy/ids_primitive.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Core IDS classes
 
 Provides the class for an IDS Primitive data type
diff --git a/imaspy/ids_root.py b/imaspy/ids_root.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Core IDS classes
 
 Provides the class for an IDS Primitive data type
diff --git a/imaspy/ids_struct_array.py b/imaspy/ids_struct_array.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ IDS StructArray represents an Array of Structures in the IDS tree.
 This contains references to :py:class:`IDSStructure`s
 
diff --git a/imaspy/ids_structure.py b/imaspy/ids_structure.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ A structure in an IDS
 
 * :py:class:`IDSStructure`
diff --git a/imaspy/ids_toplevel.py b/imaspy/ids_toplevel.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """ Represents a Top-level IDS (like NBI etc)
 * :py:class:`IDSToplevel`
 """
diff --git a/imaspy/imas_ual_env_parsing.py b/imaspy/imas_ual_env_parsing.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 def parse_UAL_version_string(string):
     """Parses a UAL_VERSION string
 
diff --git a/imaspy/setup_logging.py b/imaspy/setup_logging.py
@@ -1,5 +1,5 @@
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 import logging
 import time
 
diff --git a/setup.py b/setup.py
@@ -1,6 +1,6 @@
 # pylint: disable=wrong-import-position
 # This file is part of IMASPy.
-# You should have received IMASPy LICENSE file with this project.
+# You should have received the IMASPy LICENSE file with this project.
 """
 Packaging settings. Inspired by a minimal setup.py file, the Pandas cython build
 and the access-layer setup template.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`# This file is part of IMASPy.`
`2`		`-# You should have received IMASPy LICENSE file with this project.`
	`2`	`+# You should have received the IMASPy LICENSE file with this project.`
`3`	`3`	`#`
`4`	`4`	`# Set up pytest so that any mention of 'backend' as a test argument`
`5`	`5`	`# gets run with all four backends.`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# This file is part of IMASPy.`
`2`		`-# You should have received IMASPy LICENSE file with this project.`
	`2`	`+# You should have received the IMASPy LICENSE file with this project.`