Skip to content

Commit

Permalink
small docs fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Nicola VIGANO <nicola.vigano@cea.fr>
  • Loading branch information
Obi-Wan committed Jun 9, 2024
1 parent 8c6b9c7 commit b8f5114
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ plugins:
module_name: docs/macros
- gen-files:
scripts:
- gen_doc_stubs.py
- gen_doc_stubs.py
14 changes: 10 additions & 4 deletions src/autoden/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ def get_parser() -> argparse.ArgumentParser:
"""
Return the CLI argument parser.
Returns:
Returns
-------
argparse.ArgumentParser
An argparse parser.
"""
parser = argparse.ArgumentParser(
Expand Down Expand Up @@ -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()
Expand Down

0 comments on commit b8f5114

Please sign in to comment.