Fix codespell

Author: rly

hdmf_docutils/doctools/render.py

@@ -141,22 +141,22 @@ def update_stats(obj, parent_name):
                 type_def_key = obj.def_key()
                 type_inc_key = obj.inc_key()
                 if obj.get(type_def_key, None) is not None:
-                    nd = obj[type_def_key]
+                    ndt = obj[type_def_key]
                 else:
-                    nd = obj.get(type_inc_key, None)
+                    ndt = obj.get(type_inc_key, None)
                 specstats.add_group(name=obj_name,
-                                    data_type=nd)
+                                    data_type=ndt)
             elif isinstance(obj, DatasetSpec):
                 type_def_key = obj.def_key()
                 type_inc_key = obj.inc_key()
                 if obj.get(type_def_key, None) is not None:
-                    nd = obj[type_def_key]
+                    ndt = obj[type_def_key]
                 else:
-                    nd = obj.get(type_inc_key, None)
+                    ndt = obj.get(type_inc_key, None)
                 specstats.add_dataset(name=obj_name,
                                       shape=obj.shape,
                                       dtype=obj['type'] if hasattr(obj, 'type') else None,
-                                      data_type=nd)
+                                      data_type=ndt)
             elif isinstance(obj, AttributeSpec):
                 specstats.add_attribute(name=obj_name,
                                         value=obj.value)

hdmf_docutils/doctools/renderrst.py

@@ -451,7 +451,7 @@ def render_type_hierarchy(spec_catalog,
                            should be created.
         :type target_doc: RSTDocument or Non
         :param section_label: String with the label for the section (or None if no label should be added)
-        :param subsection_title: String with the title for the secton (or None if no section should be added)
+        :param subsection_title: String with the title for the section (or None if no section should be added)
 
         :returns: Tuple with: 1) RSTDocument with the type hierarchy,
                   2) OrderedDict with the type hierarchy itself as generated by SpecCatalog.get_full_hierarchy()
@@ -558,7 +558,7 @@ def render_specification_properties(spec, newline='\n', ignore_props=None, prepe
                 spec_prop_list.append('**Quantity:** %s' % SpecToRST.quantity_to_string(spec['quantity']))
             if spec.get('linkable', None) is not None and 'linkable' not in ignore_keys:
                 spec_prop_list.append('**Linkable:** %s' % str(spec['linkable']))
-        # Add attribute spec properites
+        # Add attribute spec properties
         if isinstance(spec, AttributeSpec):
             if 'primitive_type' not in ignore_keys:
                 spec_prop_list.append('**Primitive Type:** %s' % SpecToRST.spec_basetype_name(spec))
@@ -668,7 +668,7 @@ def render_spec_table(spec,
             # Create the description for the object
             spec_doc = SpecToRST.clean_schema_doc_string(doc_str=spec.doc,
                                                          add_prefix=rst_table.newline + rst_table.newline)
-            # Create the list of additional object properties to be added as a list ot the doc
+            # Create the list of additional object properties to be added as a list to the doc
             spec_doc += SpecToRST.render_specification_properties(spec=spec,
                                                                   newline=rst_table.newline,
                                                                   ignore_props=['primitive_type'])

hdmf_docutils/generate_format_docs.py

@@ -246,7 +246,7 @@ def render_data_type_section(section,
                     label=LabelHelper.get_src_section_label(rt,
                                                             spec_generate_src_file, spec_show_yaml_src)))
 
-        # Render the propoerties of the spec as part of the overview
+        # Render the properties of the spec as part of the overview
         type_desc_doc.add_text(SpecToRST.render_specification_properties(rt_spec,
                                                                          type_desc_doc.newline,
                                                                          ignore_props=ignore_props,
@@ -427,7 +427,7 @@ def main():
     spec_dir = spec_input_spec_dir
     # Set the names of the main output files
     doc_filename = os.path.join(file_dir, spec_output_doc_filename)  # Name of the file with main documentation
-    # Name fo the file where the YAML sources are rendered
+    # Name of the file where the YAML sources are rendered
     srcdoc_filename = os.path.join(file_dir, spec_output_src_filename) if spec_generate_src_file else None
     master_filename = os.path.join(file_dir, spec_output_master_filename)
     type_hierarchy_doc_filename = os.path.join(file_dir, spec_output_doc_type_hierarchy_filename)

hdmf_docutils/init_sphinx_extension_doc.py

@@ -418,7 +418,7 @@ def setup(app):
 }
 """
 
-    # Add the input options ot the settings
+    # Add the input options to the settings
     custom_autodoc_settings = \
 """# -*- coding: utf-8 -*-
 # Configuration file for generating sources for the format documentation from the YAML specification files
@@ -794,7 +794,7 @@ def define_cl_args():
     parser.add_argument('--resolve_type_inc', dest='resolve_type_inc', action='store', type=bool_type, required=False, default=False,
                         help="Always resolve type includes to show the full spec of an object including inherited components?")
     parser.add_argument('--latex_clearpage_after_type', dest='latex_clearpage_after_type', action='store', type=bool_type, required=False, default=True,
-                        help="Add clearpage command in latex after each neurodata_type to esnure figures always appear in the right section at the cost of adding empty space between sections.")
+                        help="Add clearpage command in latex after each neurodata_type to ensure figures always appear in the right section at the cost of adding empty space between sections.")
     parser.add_argument('--table_depth_char', dest='table_depth_char', action='store', type=str, required=False, default='.',
                         help="Char to be used to indent entries in description tables to indicate the depth of the object.")
     parser.add_argument('--abbrv_main_obj_in_table', dest='abbrv_main_obj_in_table', action='store', type=bool_type, required=False, default=True,
@@ -806,7 +806,7 @@ def define_cl_args():
     parser.add_argument('--generate_src_file', dest='generate_src_file', action='store', type=bool_type, required=False, default=True,
                         help="Generate separate reStructuredText files for the YAML sources rather than including them in the description files?")
     parser.add_argument('--show_hierarchy_plots', dest='show_hierarchy_plots', action='store', type=bool_type, required=False, default=True,
-                        help="Generate and show plots of the hierarchy for each tyep/neurodata_type?")
+                        help="Generate and show plots of the hierarchy for each type/neurodata_type?")
     parser.add_argument('--show_yaml_src', dest='show_yaml_src', action='store', type=bool_type, required=False, default=True,
                         help="Show the source specification as YAML.")
     parser.add_argument('--custom_description', dest='custom_description', action='store', type=str, required=False, default=None,