Merge branch 'cleanup/code-comments-v3' into 'main'

chore: trim trailing whitespace inside code comments

Closes #193

See merge request postgres-ai/postgresai!265

Author: Sarumyan

cli/lib/checkup.ts

@@ -2,41 +2,41 @@
  * Express Checkup Module
  * ======================
  * Generates JSON health check reports directly from PostgreSQL without Prometheus.
- * 
+ *
  * ARCHITECTURAL DECISIONS
  * -----------------------
- * 
+ *
  * 1. SINGLE SOURCE OF TRUTH FOR SQL QUERIES
- *    Complex metrics (index health, settings, db_stats) are loaded from 
+ *    Complex metrics (index health, settings, db_stats) are loaded from
  *    config/pgwatch-prometheus/metrics.yml via getMetricSql() from metrics-loader.ts.
- *    
+ *
  *    Simple queries (version, database list, connection states, uptime) use
  *    inline SQL as they're trivial and CLI-specific.
- * 
+ *
  * 2. JSON SCHEMA COMPLIANCE
  *    All generated reports MUST comply with JSON schemas in reporter/schemas/.
  *    These schemas define the expected format for both:
  *    - Full-fledged monitoring reporter output
  *    - Express checkup output
- * 
+ *
  *    Before adding or modifying a report, verify the corresponding schema exists
  *    and ensure the output matches. Run schema validation tests to confirm.
- * 
+ *
  * 3. ERROR HANDLING STRATEGY
  *    Functions follow two patterns based on criticality:
- * 
+ *
  *    PROPAGATING (throws on error):
  *    - Core data functions: getPostgresVersion, getSettings, getAlteredSettings,
  *      getDatabaseSizes, getInvalidIndexes, getUnusedIndexes, getRedundantIndexes
  *    - If these fail, the entire report should fail (data is required)
  *    - Callers should handle errors at the report generation level
- * 
+ *
  *    GRACEFUL DEGRADATION (catches errors, includes error in output):
  *    - Optional/supplementary queries: pg_stat_statements, pg_stat_kcache checks,
  *      memory calculations, postmaster startup time
  *    - These are nice-to-have; missing data shouldn't fail the whole report
  *    - Errors are logged and included in report output for visibility
- * 
+ *
  * ADDING NEW REPORTS
  * ------------------
  * 1. Add/verify the metric exists in config/pgwatch-prometheus/metrics.yml
@@ -336,7 +336,7 @@ export function parseVersionNum(versionNum: string): { major: string; minor: str
 /**
  * Format bytes to human readable string using binary units (1024-based).
  * Uses IEC standard: KiB, MiB, GiB, etc.
- * 
+ *
  * Note: PostgreSQL's pg_size_pretty() uses kB/MB/GB with 1024 base (technically
  * incorrect SI usage), but we follow IEC binary units per project style guide.
  */
@@ -387,7 +387,7 @@ function formatSettingPrettyValue(
 /**
  * Get PostgreSQL version information.
  * Uses simple inline SQL (trivial query, CLI-specific).
- * 
+ *
  * @throws {Error} If database query fails (propagating - critical data)
  */
 export async function getPostgresVersion(client: Client): Promise<PostgresVersion> {
@@ -1084,7 +1084,7 @@ export const generateH004 = (client: Client, nodeName = "node-01") =>
 
 /**
  * Generate D004 report - pg_stat_statements and pg_stat_kcache settings.
- * 
+ *
  * Uses graceful degradation: extension queries are wrapped in try-catch
  * because extensions may not be installed. Errors are included in the
  * report output rather than failing the entire report.

cli/lib/init.ts

@@ -87,7 +87,7 @@ export type AdminConnection = {
 /**
  * Check if an error indicates SSL negotiation failed and fallback to non-SSL should be attempted.
  * This mimics libpq's sslmode=prefer behavior.
- * 
+ *
  * IMPORTANT: This should NOT match certificate errors (expired, invalid, self-signed)
  * as those are real errors the user needs to fix, not negotiation failures.
  */

cli/lib/metrics-loader.ts

@@ -1,6 +1,6 @@
 /**
  * Metrics loader for express checkup reports
- * 
+ *
  * Loads SQL queries from embedded metrics data (generated from metrics.yml at build time).
  * Provides version-aware query selection and row transformation utilities.
  */
@@ -9,7 +9,7 @@ import { METRICS, MetricDefinition } from "./metrics-embedded";
 
 /**
  * Get SQL query for a specific metric, selecting the appropriate version.
- * 
+ *
  * @param metricName - Name of the metric (e.g., "settings", "db_stats")
  * @param pgMajorVersion - PostgreSQL major version (default: 16)
  * @returns SQL query string
@@ -41,7 +41,7 @@ export function getMetricSql(metricName: string, pgMajorVersion: number = 16): s
 
 /**
  * Get metric definition including all metadata.
- * 
+ *
  * @param metricName - Name of the metric
  * @returns MetricDefinition or undefined if not found
  */

reporter/postgres_reports.py

@@ -259,7 +259,7 @@ def get_index_definitions_from_sink(self, db_name: str = None) -> Dict[str, str]
                 # 1. This method is called VERY rarely (only during report generation)
                 # 2. The table size is expected to remain small (< 10000 rows per database)
                 # 3. Current latency is well under 1 second for typical workloads
-                # 
+                #
                 # If the table grows significantly larger (>> 10000 rows) or latency exceeds 1s,
                 # consider adding a GIN index on the data JSONB column or materialized view.
                 if db_name:
@@ -1107,7 +1107,7 @@ def generate_d004_pgstat_settings_report(self, cluster: str = "local", node_name
         # Check if pg_stat_kcache extension is available and working by querying its metrics
         kcache_status = self._check_pg_stat_kcache_status(cluster, node_name)
 
-        # Check if pg_stat_statements is available and working by querying its metrics  
+        # Check if pg_stat_statements is available and working by querying its metrics
         pgss_status = self._check_pg_stat_statements_status(cluster, node_name)
 
         return self.format_report_data(
@@ -1635,7 +1635,7 @@ def _analyze_memory_settings(self, memory_data: Dict[str, Any]) -> Dict[str, Any
                 "effective_cache_size_pretty": self.format_bytes(effective_cache_size)
             }
 
-            # Generate recommendations                            
+            # Generate recommendations
         except (ValueError, TypeError):
             # If parsing fails, return empty analysis
             analysis["estimated_total_memory_usage"] = {}
@@ -3285,7 +3285,7 @@ def _get_pgss_metrics_data(self, cluster: str, node_name: str, start_time: datet
                 if start_result:
                     start_data.extend(start_result)
 
-                # Query metrics around end time  
+                # Query metrics around end time
                 end_result = self.query_range(metric_with_filters, end_time - timedelta(minutes=1),
                                               end_time + timedelta(minutes=1))
                 if end_result:
@@ -4976,7 +4976,7 @@ def _get_pgss_metrics_data_by_db(self, cluster: str, node_name: str, db_name: st
                     start_data.extend(start_result)
                     metrics_found += 1
 
-                # Query metrics around end time  
+                # Query metrics around end time
                 end_result = self.query_range(metric_with_filters, end_time - timedelta(minutes=1),
                                               end_time + timedelta(minutes=1))
                 if end_result: