From 40dcc42e0e0c195b253b9ff6c5b2c80cca68c432 Mon Sep 17 00:00:00 2001 From: Stefan Bienert <stefan.bienert@unibas.ch> Date: Mon, 10 Aug 2015 17:49:54 +0200 Subject: [PATCH] Fixed documentation --- core/doc/argcheck.rst | 8 +++++--- core/doc/pm3argparse.rst | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/core/doc/argcheck.rst b/core/doc/argcheck.rst index 53f517f1..b9a35a62 100644 --- a/core/doc/argcheck.rst +++ b/core/doc/argcheck.rst @@ -9,8 +9,8 @@ Introduction For parsing command line arguments - :py_docs:`optional <howto/argparse.html#introducing-optional-arguments>` and :py_docs:`positional <howto/argparse.html#introducing-positional-arguments>` - -|project| tools should utilise Pythons own -:py_docs:`argparse <library/argparse.html>` module. While this comes with a lot +|project| tools should utilise its own +:mod:`~promod3.core.pm3argparse` module. While this comes with a lot of functionality to fetch values from the command line comfortably, it has no means in checking/ verifying input. Some of the most common tests are covered here. All tests are designed to exit a script on failure. @@ -63,4 +63,6 @@ File Tests .. autofunction:: FileExtension -.. LocalWords: currentmodule py howto argparse +.. LocalWords: currentmodule py howto argparse testcode argcheck os promod +.. LocalWords: tempfile fh fn ArgumentParser str args FileExists gz pdb +.. LocalWords: FileExtension mmcif doctest autofunction diff --git a/core/doc/pm3argparse.rst b/core/doc/pm3argparse.rst index 359b6755..43e05c12 100644 --- a/core/doc/pm3argparse.rst +++ b/core/doc/pm3argparse.rst @@ -3,6 +3,8 @@ .. currentmodule:: promod3.core.pm3argparse +.. module:: promod3.core.pm3argparse + Introduction -------------------------------------------------------------------------------- -- GitLab