| -rw-r--r-- | doc/user-manual/general.rst | 6 | ||||
| -rw-r--r-- | doc/user-manual/intro.rst | 10 |
diff --git a/doc/user-manual/general.rst b/doc/user-manual/general.rst index db7e4e41..fd6dd908 100644 --- a/doc/user-manual/general.rst +++ b/doc/user-manual/general.rst @@ -22,3 +22,9 @@ Overview .. function:: restore_env() This function restores the original environment by removing the effect of all the :func:`use` calls made before. + +.. function:: help(f) + + Print some help, if available, about the function "f". + In the first line it will be shown how the function should be called. + If the function have some optional parameters these will be shown inside square brackets. diff --git a/doc/user-manual/intro.rst b/doc/user-manual/intro.rst index 9bb7cf35..0fbf9bbf 100644 --- a/doc/user-manual/intro.rst +++ b/doc/user-manual/intro.rst @@ -89,6 +89,16 @@ To obtain the following plot: As you can see the graphical system is very flexible and it does offer a lot of possibilities. If you want to learn more about the graphical system you can read the chapter about :ref:`graphics <graphics-chapter>`. +Getting Help +~~~~~~~~~~~~ + +When you are using GSL Shell interactively you get easily help about any function by using the function:: + + help(some_function) + +to obtain a short text that explain what the function does and the arguments that it gets. +If the arguments are enclosed in square bracket it means that these arguments are optional. + .. _complex_numbers: Complex numbers |