Update app.py

app.py

@@ -929,13 +929,16 @@ class FAADocumentChecker(DocumentChecker):
         if not self.validate_input(doc):
             return DocumentCheckResult(success=False, issues=[{'error': 'Invalid document input'}])
 
-        # Use instance variables for heading words and predefined acronyms
+        # Common words that might appear in uppercase but aren't acronyms
         heading_words = self.config_manager.config.get('heading_words', self.HEADING_WORDS)
+
+        # Standard acronyms that don't need to be defined
         predefined_acronyms = self.config_manager.config.get('predefined_acronyms', self.PREDEFINED_ACRONYMS)
 
         # Tracking structures
         defined_acronyms = {}  # Stores definition info
         used_acronyms = set()  # Stores acronyms used after definition
+        reported_acronyms = set()  # Stores acronyms that have already been noted as issues
         issues = []
 
         # Patterns
@@ -943,12 +946,12 @@ class FAADocumentChecker(DocumentChecker):
         acronym_pattern = re.compile(r'(?<!\()\b[A-Z]{2,}\b(?!\s*[:.]\s*)')
 
         for paragraph in doc:
-            # Skip lines that appear to be headings
+            # Skip lines that appear to be headings (all uppercase with common heading words)
             words = paragraph.strip().split()
             if all(word.isupper() for word in words) and any(word in heading_words for word in words):
                 continue
 
-            # Check for acronym definitions
+            # Check for acronym definitions first
             defined_matches = defined_pattern.findall(paragraph)
             for full_term, acronym in defined_matches:
                 if acronym not in predefined_acronyms:
@@ -956,7 +959,7 @@ class FAADocumentChecker(DocumentChecker):
                         defined_acronyms[acronym] = {
                             'full_term': full_term.strip(),
                             'defined_at': paragraph.strip(),
-                            'used': False
+                            'used': False  # Initially not used
                         }
 
             # Check for acronym usage
@@ -968,10 +971,17 @@ class FAADocumentChecker(DocumentChecker):
                 if acronym in predefined_acronyms:
                     continue
 
-                if acronym not in defined_acronyms:
-                    # Undefined acronym used
-                    issues.append(acronym)
-                else:
+                # Skip if it's part of a heading or contains non-letter characters
+                if (acronym in heading_words or
+                    any(not c.isalpha() for c in acronym) or
+                    len(acronym) > 10):  # Usually acronyms aren't this long
+                    continue
+
+                if acronym not in defined_acronyms and acronym not in reported_acronyms:
+                    # Undefined acronym used; report only once
+                    issues.append(f"Confirm '{acronym}' was defined at its first use.")
+                    reported_acronyms.add(acronym)  # Add to reported list
+                elif acronym in defined_acronyms:
                     # Mark as used
                     defined_acronyms[acronym]['used'] = True
                     used_acronyms.add(acronym)
@@ -979,7 +989,8 @@ class FAADocumentChecker(DocumentChecker):
         # Define success based on whether there are any undefined acronyms
         success = len(issues) == 0
 
-        return DocumentCheckResult(success=success, issues=list(set(issues)))
+        # Return the result with detailed issues
+        return DocumentCheckResult(success=success, issues=issues)
 
     @profile_performance
     def acronym_usage_check(self, doc: List[str]) -> DocumentCheckResult:
@@ -1806,11 +1817,11 @@ class DocumentCheckResultsFormatter:
             },
             'acronym_usage_check': {
                 'title': 'Unused Acronym Definitions',
-                'description': 'Ensures all acronyms defined in the document are subsequently used. If a term is defined but not used, it should not be defined.',
-                'solution': 'Remove definitions for acronyms that are not used later in the document.',
+                'description': 'Ensures that all acronyms defined in the document are actually used later. If an acronym is defined but never referenced, the definition should be removed to avoid confusion or unnecessary clutter.',
+                'solution': 'Identify acronyms that are defined but not used later in the document and remove their definitions.',
                 'example_fix': {
-                    'before': 'Airworthiness Directive (AD) requirements are critical.',
-                    'after': 'Remove "Airworthiness Directive (AD)" if "AD" is not used elsewhere.'
+                    'before': 'Operators must comply with Airworthiness Directives (AD) to ensure aircraft safety and regulatory compliance.',
+                    'after': 'Remove "(AD)" of "Airworthiness Directives (AD)" if "AD" is not used later in the document.'
                 }
             },
             'terminology_check': {
@@ -2192,11 +2203,11 @@ class DocumentCheckResultsFormatter:
         
         self.issue_categories['acronym_usage_check'] = {
             'title': 'Unused Acronym Definitions',
-            'description': 'Ensures all acronyms defined in the document are subsequently used.',
-            'solution': 'Remove definitions for acronyms that are not used later in the document.',
+            'description': 'Ensures that all acronyms defined in the document are actually used later. If an acronym is defined but never referenced, the definition should be removed to avoid confusion or unnecessary clutter.',
+            'solution': 'Identify acronyms that are defined but not used later in the document and remove their definitions.',
             'example_fix': {
-                'before': 'Airworthiness Directive (AD) requirements are critical.',
-                'after': 'Remove "Airworthiness Directive (AD)" if "AD" is not used elsewhere.'
+                'before': 'Operators must comply with Airworthiness Directives (AD) to ensure aircraft safety and regulatory compliance.',
+                'after': 'Remove "(AD)" of "Airworthiness Directives (AD)" if "AD" is not used later in the document.'
             }
         }