fix typos, add codespell ignore to pass style checks

fix potential typos in python string concatenation

fix another typo

fix 'stora' typos

fix 'diffucult' typo

ignore codespell warning for .metrix

Author: MyApaulogies

config/adamant.configuration.yaml.original

@@ -74,7 +74,7 @@ ccsds_packet_buffer_size: 1274
 # define the amount of "usable" stack used by the Stack Monitor component. You should 
 # size this value as small as possible, but the value MUST be larger than the amount
 # of stack that a task uses prior to calling the Cycle procedure the first time, and MUST
-# be smaller than that smallest task stack efined in the system. When in doubt, leave 
+# be smaller than that smallest task stack defined in the system. When in doubt, leave 
 # this value at the default.
 #
 # Note, this value only affects bareboard runtimes. Linux uses a predefined stack margin

doc/QuickStartGuide.md

@@ -337,7 +337,7 @@ redo build/src/<component_name>_events.adb
 redo build/src/<component_name>_events.ads
 ```
 
-You can view an html table of your events by running `redo build/html/<component_name>_events.html`. The autgenerated source code for creating events can be found in `build/src/<component_name>_events.ad[b,s]`. The representation package, which allows you to print events in a human readable form is generated in `build/src/<component_name>_events-representation.ad[b,s]`. Each of these source code packages can be compiled into their corresponding objects using the `redo build/obj/..` commands above.
+You can view an html table of your events by running `redo build/html/<component_name>_events.html`. The autogenerated source code for creating events can be found in `build/src/<component_name>_events.ad[b,s]`. The representation package, which allows you to print events in a human readable form is generated in `build/src/<component_name>_events-representation.ad[b,s]`. Each of these source code packages can be compiled into their corresponding objects using the `redo build/obj/..` commands above.
 
 Now, you will be able to create events inside of your component using the `self.events` record element.
 
@@ -368,7 +368,7 @@ redo build/src/<component_name>_data_products.adb
 redo build/src/<component_name>_data_products.ads
 ```
 
-You can view an html table of your data products by running `redo build/html/<component_name>_data_products.html`. The autgenerated source code for creating data products can be found in `build/src/<component_name>_data_products.ad[b,s]`. The representation package, which allows you to print data products in a human readable form is generated in `build/src/<component_name>_data_products-representation.ad[b,s]`. Each of these source code packages can be compiled into their corresponding objects using the `redo build/obj/..` commands above.
+You can view an html table of your data products by running `redo build/html/<component_name>_data_products.html`. The autogenerated source code for creating data products can be found in `build/src/<component_name>_data_products.ad[b,s]`. The representation package, which allows you to print data products in a human readable form is generated in `build/src/<component_name>_data_products-representation.ad[b,s]`. Each of these source code packages can be compiled into their corresponding objects using the `redo build/obj/..` commands above.
 
 Now, you will be able to create data products inside of your component using the `self.data_products` record element.
 
@@ -395,7 +395,7 @@ redo build/src/<component_name>_commands.adb
 redo build/src/<component_name>_commands.ads
 ```
 
-You can view an html table of your commands by running `redo build/html/<component_name>_commands.html`. The autgenerated source code for creating commands can be found in `build/src/<component_name>_commands.ad[b,s]`. This source code packages can be compiled into its corresponding objects using the `redo build/obj/Linux/<component_name>_commands.o` command.
+You can view an html table of your commands by running `redo build/html/<component_name>_commands.html`. The autogenerated source code for creating commands can be found in `build/src/<component_name>_commands.ad[b,s]`. This source code packages can be compiled into its corresponding objects using the `redo build/obj/Linux/<component_name>_commands.o` command.
 
 Now, the autocoder will generate the code necessary to route commands to specific user-implemented handler functions. You can see these handlers if you generate the component template code following the instructions in the "Creating a Component" section.
 

doc/user_guide/user_guide.tex

@@ -1236,7 +1236,7 @@ \subsubsection{``White-box" Unit Testing}
 \newpage
 \section{Packed Types} \label{Packed Types}
 
-Often in embedded systems, communication protocols and hardware devices require a very specific binary format for transferred bytes or bits to properly function. However, technical differences in processors and compilers can often make code built to talk to these devices diffucult to implement in a cross-platform and portable way. For instance, processors used in the design of embedded systems can be either big or little endian, depending on the chosen platform. Embedded systems often communicate with other embedded processors or end-user systems which have an endianness different from their own. If not carefully handled, these differences in endianness can be one of the largest sources of defects encountered while debugging embedded software. Besides endianness issues, the ``packed"-ness, that is, the amount of padding supplied around individual types, of a struct or array in processor memory differs based on the compiler used. The differences in endianness and ``packed"-ness can make writing portable software difficult without a layer of abstraction to handle the differences. \\
+Often in embedded systems, communication protocols and hardware devices require a very specific binary format for transferred bytes or bits to properly function. However, technical differences in processors and compilers can often make code built to talk to these devices difficult to implement in a cross-platform and portable way. For instance, processors used in the design of embedded systems can be either big or little endian, depending on the chosen platform. Embedded systems often communicate with other embedded processors or end-user systems which have an endianness different from their own. If not carefully handled, these differences in endianness can be one of the largest sources of defects encountered while debugging embedded software. Besides endianness issues, the ``packed"-ness, that is, the amount of padding supplied around individual types, of a struct or array in processor memory differs based on the compiler used. The differences in endianness and ``packed"-ness can make writing portable software difficult without a layer of abstraction to handle the differences. \\
 
 Adamant aims to solve these problem through the use of \textit{packed types}.  In Adamant, packed types are modeled using a YAML specification. From the specification, the following type definitions are generated:
 

gen/templates/array/name.py

@@ -32,29 +32,29 @@ def __init__(self, elements=[]):
             assert isinstance(elements, list), \
                 "Expected type for elements to be 'list' and instead found '" + str(type(elements))
             assert len(elements) == self.length, \
-                ("Expected length of element array to be '" + str(self.length) + "'"
+                ("Expected length of element array to be '" + str(self.length) + "' "
                  "but instead found length of: " + str(len(elements)))
             for e in elements:
                 if e is not None:
 {% if element.is_packed_type %}
                     assert isinstance(e, {{ element.type_package }}), \
-                        ("Expected type for elements to be '{{ element.type_package }}'"
+                        ("Expected type for elements to be '{{ element.type_package }}' "
                          "and instead found '" + str(type(e)))
 {% elif element.is_enum %}
                     assert isinstance(e, {{ element.type_model.name }}), \
-                        ("Expected type for elements to be '{{ element.type_model.name }}'"
+                        ("Expected type for elements to be '{{ element.type_model.name }}' "
                          "and instead found '" + str(type(e)))
 {% else %}
 {% if element.format %}
 {% if element.format.length %}
                     assert isinstance(e, list), \
                         "Expected type for elements to be 'list' and instead found '" + str(type(e))
                     assert len(e) == {{ element.format.length }}, \
-                        ("Expected length of list for elements to be '{{ element.format.length }}'"
+                        ("Expected length of list for elements to be '{{ element.format.length }}' "
                          "but instead found a list of length '" + str(len(e)) + "'.")
 {% else %}
                     assert isinstance(e, {{ element.format.get_python_type_string() }}), \
-                        ("Expected type for elements to be '{{ element.format.get_python_type_string() }}'"
+                        ("Expected type for elements to be '{{ element.format.get_python_type_string() }}' "
                          "and instead found '" + str(type(e)))
 {% if element.format.type[0] == "U" %}
                     assert e >= 0, \

gen/templates/record/name.py

@@ -40,11 +40,11 @@ def __init__(
         if {{ field.name }} is not None:
 {% if field.is_enum %}
             assert isinstance({{ field.name }}, {{ field.type_model.name }}), \
-                ("Expected type for field '{{ field.name }}' to be '{{ field.type_model.name }}'"
+                ("Expected type for field '{{ field.name }}' to be '{{ field.type_model.name }}' "
                  " and instead found '" + str(type({{ field.name }})))
 {% elif field.is_packed_type %}
             assert isinstance({{ field.name }}, {{ field.type_package }}), \
-                ("Expected type for field '{{ field.name }}' to be '{{ field.type_package }}'"
+                ("Expected type for field '{{ field.name }}' to be '{{ field.type_package }}' "
                  "and instead found '" + str(type({{ field.name }})))
 {% if field.variable_length %}
             # Make sure variable length field value is not larger than the packed array length
@@ -64,7 +64,7 @@ def __init__(
             if self.{{ field.variable_length }} is not None:
                 assert (self.{{ field.variable_length }} + int({{ field.variable_length_offset }})) == len({{ field.name }}), \
                     ("Expected length of variable length field '{{ field.name }}' to match value of "
-                     "'{{ field.variable_length }} + int({{ field.variable_length_offset }})'"
+                     "'{{ field.variable_length }} + int({{ field.variable_length_offset }})' "
                      "which is '" + str((self.{{ field.variable_length }} + int({{ field.variable_length_offset }}))) + ""
                      "', but instead found length of '" + str(len({{ field.name }})) + "'.")
 {% else %}
@@ -75,7 +75,7 @@ def __init__(
 {% else %}
             assert isinstance({{ field.name }}, {{ field.format.get_python_type_string() }}), \
                 ("Expected type for field '{{ field.name }}' to be "
-                 "'{{ field.format.get_python_type_string() }}'"
+                 "'{{ field.format.get_python_type_string() }}' "
                  "and instead found '" + str(type({{ field.name }})))
 {% if field.format.type[0] == "U" %}
             assert {{ field.name }} >= 0, \

redo/rules/build_metric.py

@@ -82,7 +82,7 @@ def _build(self, redo_1, redo_2, redo_3):
         metric_dir = os.path.join(
             root_dir, "build" + os.sep + "metric" + os.sep + build_target
         )
-        detailed_metric_dir = os.path.join(metric_dir, redo_no_txt_base + ".metrix")
+        detailed_metric_dir = os.path.join(metric_dir, redo_no_txt_base + ".metrix")  # codespell:ignore metrix
         cargs_string = ""
         filesystem.safe_makedir(detailed_metric_dir)
 

redo/targets/linux.py

@@ -23,7 +23,7 @@ def path_files(self):
 # This is the standard debug Linux target.
 class Linux_Debug(Linux_Base):
     def description(self):
-        return ("This native 64-bit Linux target has no optimization, compiles with debug flags"
+        return ("This native 64-bit Linux target has no optimization, compiles with debug flags "
                 "enabled, and enforces the Ravenscar profile.")
 
     def gpr_project_file(self):
@@ -42,7 +42,7 @@ def description(self):
 # Test target which links in aunit:
 class Linux_Test(Linux_Base):
     def description(self):
-        return ("Same as Linux_Debug except it does not enforce the Ravenscar profile and links"
+        return ("Same as Linux_Debug except it does not enforce the Ravenscar profile and links "
                 "with AUnit.")
 
     def gpr_project_file(self):
@@ -55,7 +55,7 @@ def gpr_project_file(self):
 # Coverage target which works with gcov:
 class Linux_Coverage(Linux_Base):
     def description(self):
-        return ("Same as Linux_Test except it adds compilation flags to assist with coverage analysis"
+        return ("Same as Linux_Test except it adds compilation flags to assist with coverage analysis "
                 "via gcov.")
 
     def path_files(self):

redo/util/redo.py

@@ -106,7 +106,7 @@ def info_print_bold(string):
     sys.stderr.flush()
 
 
-# Maing function to facilitate testing this modukle
+# Main function to facilitate testing this module
 # from the commandline.
 if __name__ == "__main__":
     command_dict = {

src/components/ccsds_command_depacketizer/ccsds_command_depacketizer.events.yaml

@@ -4,7 +4,7 @@ events:
     description: A packet was received with an invalid checksum
     param_type: Invalid_Packet_Xor8_Info.T
   - name: Invalid_Packet_Type
-    description: A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemtry packet was received.
+    description: A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemetry packet was received.
     param_type: Ccsds_Primary_Header.T
   - name: Packet_Too_Small
     description: The packet received was too small to contain necessary command information.

src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.adb

@@ -136,7 +136,7 @@ package body Component.Ccsds_Command_Depacketizer.Implementation.Tester is
       Self.Invalid_Packet_Checksum_History.Push (Arg);
    end Invalid_Packet_Checksum;
 
-   -- A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemtry packet was received.
+   -- A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemetry packet was received.
    overriding procedure Invalid_Packet_Type (Self : in out Instance; Arg : in Ccsds_Primary_Header.T) is
    begin
       -- Push the argument onto the test history for looking at later:

src/components/ccsds_command_depacketizer/test/component-ccsds_command_depacketizer-implementation-tester.ads

@@ -108,7 +108,7 @@ package Component.Ccsds_Command_Depacketizer.Implementation.Tester is
    -----------------------------------------------
    -- A packet was received with an invalid checksum
    overriding procedure Invalid_Packet_Checksum (Self : in out Instance; Arg : in Invalid_Packet_Xor8_Info.T);
-   -- A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemtry packet was received.
+   -- A packet was received with an invalid ccsds packet type. The expected packet type is a telecommand, but a telemetry packet was received.
    overriding procedure Invalid_Packet_Type (Self : in out Instance; Arg : in Ccsds_Primary_Header.T);
    -- The packet received was too small to contain necessary command information.
    overriding procedure Packet_Too_Small (Self : in out Instance; Arg : in Invalid_Packet_Length.T);

src/components/ccsds_product_extractor/ccsds_product_extractor.requirements.yaml

@@ -3,5 +3,5 @@ description: The requirements for the CCSDS downsampler component are specified
 requirements:
   - text: The component shall take receive ccsds packets and extract a data type if it is part of the initial list of products.
   - text: The component shall check the type of the extracted product and verify that it is valid.
-  - text: The component shall forward data products when extracted and verifyed.
+  - text: The component shall forward data products when extracted and verified.
   - text: The component shall send errors when the extraction is invalid or out of the range of the packet.

src/components/event_filter/event_filter_entry/test/event_filter_entry.tests.yaml

@@ -1,5 +1,5 @@
 ---
-description: This is a unit test suite forthe two_counter_entry object for help with the event_limiter
+description: This is a unit test suite for the two_counter_entry object for help with the event_limiter
 tests:
   - name: Test_Init_List
     description: This test is intended to test the different permutations of the init of the byte array.
@@ -14,4 +14,4 @@ tests:
   - name: Test_Global_Enable_Switch
     description: A unit test that will just test getting and setting a master state from enabled and disabled
   - name: Test_Get_Entry_Array
-    description: Test to make sure that we appropriately get the byte array access for packetizing in the component.
+    description: Test to make sure that we appropriately get the byte array access for packetizing in the component.

src/components/event_filter/event_filter_entry/test/event_filter_entry_tests-implementation.ads

@@ -2,7 +2,7 @@
 -- Event_Filter_Entry Tests Spec
 --------------------------------------------------------------------------------
 
--- This is a unit test suite forthe two_counter_entry object for help with the event_limiter
+-- This is a unit test suite for the two_counter_entry object for help with the event_limiter
 package Event_Filter_Entry_Tests.Implementation is
    -- Test data and state:
    type Instance is new Event_Filter_Entry_Tests.Base_Instance with private;

src/components/event_limiter/two_counter_entry/test/two_counter_entry.tests.yaml

@@ -1,5 +1,5 @@
 ---
-description: This is a unit test suite forthe two_counter_entry object for help with the event_limiter
+description: This is a unit test suite for the two_counter_entry object for help with the event_limiter
 tests:
   - name: Test_Init_List
     description: This test is intended to test the different permutations of the init of the byte array.
@@ -16,4 +16,4 @@ tests:
   - name: Test_Get_Event_Range
     description: Unit test to get the range of the event ids for the component
   - name: Test_Master_Enable_Switch
-    description: A unit test that will just test getting and setting a master state from enabled and disabled
+    description: A unit test that will just test getting and setting a master state from enabled and disabled

src/components/event_limiter/two_counter_entry/test/two_counter_entry_tests-implementation.ads

@@ -2,7 +2,7 @@
 -- Two_Counter_Entry Tests Spec
 --------------------------------------------------------------------------------
 
--- This is a unit test suite forthe two_counter_entry object for help with the event_limiter
+-- This is a unit test suite for the two_counter_entry object for help with the event_limiter
 package Two_Counter_Entry_Tests.Implementation is
    -- Test data and state:
    type Instance is new Two_Counter_Entry_Tests.Base_Instance with private;

src/components/limiter/test/limiter_tests-implementation.adb

@@ -321,7 +321,7 @@ package body Limiter_Tests.Implementation is
       T : Component_Tester_Package.Instance_Access renames Self.Tester;
       Param : Parameter.T := T.Parameters.Max_Sends_Per_Tick ((Value => 0));
    begin
-      -- Make the perameter invalid by modifying its length.
+      -- Make the parameter invalid by modifying its length.
       Param.Header.Buffer_Length := 0;
 
       -- Send bad parameter and expect bad response: