From 742c5f38a9a9ede62102d692bf0591843ae9dea6 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Sun, 27 Sep 2026 21:12:51 +0200 Subject: docs(cli): refine help and docstrings Clarify that quiet mode also suppresses verbose output and simplify the run_command docstring wording. Add the missing None return annotation to the main CLI callback. --- prometheus_pacman_exporter/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'prometheus_pacman_exporter/__init__.py') diff --git a/prometheus_pacman_exporter/__init__.py b/prometheus_pacman_exporter/__init__.py index 4c45116..3e29849 100644 --- a/prometheus_pacman_exporter/__init__.py +++ b/prometheus_pacman_exporter/__init__.py @@ -125,7 +125,7 @@ def run_command( command: tuple[str, ...], accepted_exit_codes: tuple[int, ...] = (0,), ) -> subprocess.CompletedProcess[str]: - """Run a shell command and return the result. + """Run a command and return the result. Logs the command at debug level before execution. Exits the application with the command's return code if it fails. @@ -187,7 +187,7 @@ def run_command( "quiet_flag", is_flag=True, default=False, - help="Suppress all non-error output.", + help="Suppress all non-error output, including verbose output.", ) @click.option( "-v", @@ -215,7 +215,7 @@ def prometheus_pacman_exporter( aur_command: str | None, quiet_flag: bool, verbose_flag: bool, -): +) -> None: """Collect pacman package metrics and export them for Prometheus. Queries pacman for installed package statistics and available updates, then -- cgit v1.3.1