Merge pull request #2219 from thseiler/code-climate/fix-string-literal-comments

code-climate: fix string-literal-comments

Author: stanislaw

strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -445,10 +445,10 @@ def _convert_section_to_spec_object(
         )
         attributes.append(title_attribute)
 
-        """
-        If MIDs is enabled and this section has an MID, use it for
-        SPEC-OBJECT IDENTIFIER.
-        """
+        #
+        # If MIDs is enabled and this section has an MID, use it for
+        # SPEC-OBJECT IDENTIFIER.
+        #
         enable_mid = context.enable_mid and parent_document.config.enable_mid
         section_identifier: str
         if enable_mid and section.reserved_mid is not None:

strictdoc/backend/sdoc_source_code/models/source_file_info.py

@@ -29,12 +29,11 @@ def __init__(self, g_parts: List):
         self.source_file: Optional[SourceFile] = None
         self.functions: List[Function] = []
 
-        """
-        {
-         "REQ-001": [RangeMarker(...), ...],
-         "REQ-002": [RangeMarker(...), ...],
-        }
-        """
+        #
+        # {                                              # noqa: ERA001
+        #  "REQ-001": [RangeMarker(...), ...],           # noqa: ERA001
+        #  "REQ-002": [RangeMarker(...), ...],           # noqa: ERA001
+        # }                                              # noqa: ERA001
         self.ng_map_reqs_to_markers = {}
 
         self.ng_map_names_to_markers: Dict[str, List] = {}

strictdoc/backend/sdoc_source_code/test_reports/junit_xml_reader.py

@@ -168,9 +168,9 @@ def read_from_string(
             )
             test_suite_section.section_contents.append(testcase_node)
 
-            """
-            Parse individual <testcase> elements.
-            """
+            #
+            # Parse individual <testcase> elements.
+            #
 
             xml_testcase_list: List[Any] = xml_testsuite_.find_all(
                 "testcase", recursive=False
@@ -216,16 +216,16 @@ def read_from_string(
                 elif xml_skipped_or_none is not None:
                     test_case_node_status = "SKIPPED"
 
-                """
-                Different tools produce different outputs when it comes to how
-                the test names and paths are stored. Each tool's output is
-                handled separately below.
-                """
+                #
+                # Different tools produce different outputs when it comes to how
+                # the test names and paths are stored. Each tool's output is
+                # handled separately below.
+                #
                 if xml_format == JUnitXMLFormat.LLVM_LIT:
-                    """
-                    Example produced by LLVM LIT:
-                    <testcase classname="StrictDoc integration tests.tests/integration" name="test.ignored.itest" time="5.50"/>
-                    """
+                    #
+                    # Example produced by LLVM LIT:
+                    # <testcase classname="StrictDoc integration tests.tests/integration" name="test.ignored.itest" time="5.50"/>
+                    #
 
                     rel_path_to_test_suite = (
                         project_config.test_report_root_dict.get(

strictdoc/core/project_config.py

@@ -145,7 +145,7 @@ def __init__(
 
         # Settings derived from the command-line parameters.
 
-        # Common settings
+        # Common settings.
         self.input_paths: Optional[List[str]] = None
         self.output_dir: str = "output"
 

strictdoc/core/traceability_index.py

@@ -918,12 +918,12 @@ def validate_node_against_anchors(
         for node_anchor_ in node.get_anchors():
             existing_node_anchor_uids.add(node_anchor_.value)
 
-        """
-        Validation 1: Assert all UIDs are either:
-        a) new
-        b) exist in this node
-        c) raise a duplication error.
-        """
+        #
+        # Validation 1: Assert all UIDs are either:
+        # a) new
+        # b) exist in this node
+        # c) raise a duplication error.
+        #
         for anchor_uid in new_anchor_uids:
             if (
                 self.graph_database.has_link(
@@ -943,10 +943,10 @@ def validate_node_against_anchors(
                     f"{node_with_duplicate_anchor.get_display_title()}."
                 )
 
-        """
-        Validation 2: Check that removed anchors do not have any incoming
-        links.
-        """
+        #
+        # Validation 2: Check that removed anchors do not have any incoming
+        # links.
+        #
         to_be_removed_anchor_uids = existing_node_anchor_uids - new_anchor_uids
         for to_be_removed_anchor_uid_ in to_be_removed_anchor_uids:
             to_be_removed_anchor: Anchor = self.graph_database.get_link_value(

strictdoc/core/traceability_index_builder.py

@@ -188,10 +188,10 @@ def create(
 
             traceability_index.document_tree.attach_source_tree(source_tree)
 
-        """
-        Resolve all modification dates to support the incremental generation of
-        all artifacts.
-        """
+        #
+        # Resolve all modification dates to support the incremental generation of
+        # all artifacts.
+        #
 
         file_dependency_manager = traceability_index.file_dependency_manager
 
@@ -303,9 +303,9 @@ def create_from_document_tree(
 
         document: SDocDocument
         for document in document_tree.document_list:
-            """
-            First, resolve all grammars that are imported from grammar files.
-            """
+            #
+            # First, resolve all grammars that are imported from grammar files.
+            #
             if document.grammar.import_from_file is not None:
                 document_grammar: Optional[DocumentGrammar] = (
                     document_tree.get_grammar_by_filename(
@@ -491,11 +491,11 @@ def create_from_document_tree(
 
                 requirement: SDocNode = node
 
-                """
-                At this point, we resolve LINKs, and the expectation is that
-                all UIDs or ANCHORS (they also have UIDs) are registered at the
-                previous pass.
-                """
+                #
+                # At this point, we resolve LINKs, and the expectation is that
+                # all UIDs or ANCHORS (they also have UIDs) are registered at the
+                # previous pass.
+                #
                 for node_field_ in node.enumerate_fields():
                     for part in node_field_.parts:
                         if isinstance(part, InlineLink):

strictdoc/core/transforms/update_grammar_element.py

@@ -49,16 +49,16 @@ def perform(self) -> bool:
             if field.field_name != existing_field.title:
                 renamed_fields_lookup[field.field_name] = existing_field.title
 
-        """
-        Convert the form object to an updated grammar element.
-        """
+        #
+        # Convert the form object to an updated grammar element.
+        #
         updated_element: GrammarElement = (
             form_object.convert_to_grammar_element(document.grammar)
         )
 
-        """
-        Compare if anything was changed in the new grammar.
-        """
+        #
+        # Compare if anything was changed in the new grammar.
+        #
         document_grammar_field_names = updated_element.get_field_titles()
 
         existing_document_grammar_field_names = (

strictdoc/export/html/form_objects/requirement_form_object.py

@@ -596,10 +596,10 @@ def validate(
         assert isinstance(traceability_index, TraceabilityIndex)
         assert isinstance(context_document, SDocDocument)
 
-        """
-        MID uniqueness check.
-        FIXME: MID uniqueness if a node is updated.
-        """
+        #
+        # MID uniqueness check.
+        # FIXME: MID uniqueness if a node is updated.
+        #
         if self.is_new and "MID" in self.fields:
             new_node_mid = self.fields["MID"][0].field_value
             if len(new_node_mid) > 0:
@@ -616,9 +616,9 @@ def validate(
                         ),
                     )
 
-        """
-        UID uniqueness check.
-        """
+        #
+        # UID uniqueness check.
+        #
         new_node_uid_or_none: Optional[str] = None
         if "UID" in self.fields:
             new_node_uid = self.fields["UID"][0].field_value
@@ -641,10 +641,10 @@ def validate(
                     ),
                 )
 
-        """
-        Ensure that UID doesn't have any incoming links if it is going to be
-        renamed or removed.
-        """
+        #
+        # Ensure that UID doesn't have any incoming links if it is going to be
+        # renamed or removed.
+        #
         if self.existing_requirement_uid is not None:
             if (
                 new_node_uid_or_none is None
@@ -670,11 +670,11 @@ def validate(
                         ),
                     )
 
-        """
-        STATEMENT or another content field (DESCRIPTION, CONTENT) checks:
-        - Must be not empty.
-        - Must be valid RST.
-        """
+        #
+        # STATEMENT or another content field (DESCRIPTION, CONTENT) checks:
+        # - Must be not empty.
+        # - Must be valid RST.
+        #
         requirement_element = self.grammar.elements_by_type[self.element_type]
         statement_field_name = requirement_element.content_field[0]
         requirement_statement = self.fields[statement_field_name][0].field_value

strictdoc/export/html/generators/traceability_matrix.py

@@ -48,17 +48,17 @@ def export(
             if relation_type_ not in discovered_relation_types:
                 del known_relations[relation_type_]
 
-        """
-        Validate that all config-provided relation tuples are actually present
-        in the existing documents.
-        A typical config entry may look like this:
-        [
-            ("Parent", None),
-            ("Parent", "Refines"),
-            ("Parent", "REQUIREMENT_FOR"),
-            ("File", None)
-        ]
-        """
+        #
+        # Validate that all config-provided relation tuples are actually present
+        # in the existing documents.
+        # A typical config entry may look like this:
+        # [                                                   # noqa: ERA001
+        #     ("Parent", None),                               # noqa: ERA001
+        #     ("Parent", "Refines"),                          # noqa: ERA001
+        #     ("Parent", "REQUIREMENT_FOR"),                  # noqa: ERA001
+        #     ("File", None)                                  # noqa: ERA001
+        # ]                                                   # noqa: ERA001
+        #
         config_relation_tuples = (
             project_config.traceability_matrix_relation_columns
             if project_config.traceability_matrix_relation_columns is not None
@@ -69,11 +69,11 @@ def export(
             bucket = known_relations[config_relation_tuple_[0]]
             assert config_relation_tuple_[1] in bucket
 
-        """
-        After the config values have been validated, merge both the
-        config-provided list of relation tuples with the list that was
-        discovered from the existing documents.
-        """
+        #
+        # After the config values have been validated, merge both the
+        # config-provided list of relation tuples with the list that was
+        # discovered from the existing documents.
+        #
         known_relations_list = list(config_relation_tuples)
         for relation_type_, bucket_ in known_relations.items():
             for relation_role_, _ in bucket_.items():

strictdoc/export/html/generators/view_objects/traceability_matrix_view_object.py

@@ -96,17 +96,17 @@ def export(
             if relation_type_ not in discovered_relation_types:
                 del known_relations[relation_type_]
 
-        """
-        Validate that all config-provided relation tuples are actually present
-        in the existing documents.
-        A typical config entry may look like this:
-        [
-            ("Parent", None),
-            ("Parent", "Refines"),
-            ("Parent", "REQUIREMENT_FOR"),
-            ("File", None)
-        ]
-        """
+        #
+        # Validate that all config-provided relation tuples are actually present
+        # in the existing documents.
+        # A typical config entry may look like this:
+        # [                                                    # noqa: ERA001
+        #     ("Parent", None),                                # noqa: ERA001
+        #     ("Parent", "Refines"),                           # noqa: ERA001
+        #     ("Parent", "REQUIREMENT_FOR"),                   # noqa: ERA001
+        #     ("File", None)                                   # noqa: ERA001
+        # ]                                                    # noqa: ERA001
+        #
         config_relation_tuples = (
             project_config.traceability_matrix_relation_columns
             if project_config.traceability_matrix_relation_columns is not None
@@ -117,11 +117,11 @@ def export(
             bucket = known_relations[config_relation_tuple_[0]]
             assert config_relation_tuple_[1] in bucket
 
-        """
-        After the config values have been validated, merge both the
-        config-provided list of relation tuples with the list that was
-        discovered from the existing documents.
-        """
+        #
+        # After the config values have been validated, merge both the
+        # config-provided list of relation tuples with the list that was
+        # discovered from the existing documents.
+        #
         known_relations_list = list(config_relation_tuples)
         for relation_type_, bucket_ in known_relations.items():
             for relation_role_, _ in bucket_.items():