From b8f5114611a55243866c63c2552b7f4f557f2ef0 Mon Sep 17 00:00:00 2001 From: Nicola VIGANO Date: Sun, 9 Jun 2024 02:07:34 +0200 Subject: [PATCH] small docs fixes Signed-off-by: Nicola VIGANO --- mkdocs.yml | 2 +- src/autoden/cli.py | 14 ++++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index b512a34..f6fbc61 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,4 +65,4 @@ plugins: module_name: docs/macros - gen-files: scripts: - - gen_doc_stubs.py \ No newline at end of file + - gen_doc_stubs.py diff --git a/src/autoden/cli.py b/src/autoden/cli.py index 3795c25..b18cbee 100644 --- a/src/autoden/cli.py +++ b/src/autoden/cli.py @@ -30,7 +30,9 @@ def get_parser() -> argparse.ArgumentParser: """ Return the CLI argument parser. - Returns: + Returns + ------- + argparse.ArgumentParser An argparse parser. """ parser = argparse.ArgumentParser( @@ -82,10 +84,14 @@ def main(args: list[str] | None = None) -> int: This function is executed when you type `autoden` or `python -m autoden`. - Arguments: - args: Arguments passed from the command line. + Parameters + ---------- + args : list[str] | None + Arguments passed from the command line. - Returns: + Returns + ------- + int An exit code. """ parser = get_parser()