"Fossies" - the Fresh Open Source Software Archive

Member "relax-5.0.0/docs/latex/functions.tex" (18 Apr 2019, 3773 Bytes) of package /linux/privat/relax-5.0.0.src.tar.bz2:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TeX and LaTeX source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    2 %                                                                             %
    3 % Copyright (C) 2005,2014 Edward d'Auvergne                                   %
    4 %                                                                             %
    5 % This file is part of the program relax (http://www.nmr-relax.com).          %
    6 %                                                                             %
    7 % This program is free software: you can redistribute it and/or modify        %
    8 % it under the terms of the GNU General Public License as published by        %
    9 % the Free Software Foundation, either version 3 of the License, or           %
   10 % (at your option) any later version.                                         %
   11 %                                                                             %
   12 % This program is distributed in the hope that it will be useful,             %
   13 % but WITHOUT ANY WARRANTY; without even the implied warranty of              %
   14 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               %
   15 % GNU General Public License for more details.                                %
   16 %                                                                             %
   17 % You should have received a copy of the GNU General Public License           %
   18 % along with this program.  If not, see <http://www.gnu.org/licenses/>.       %
   19 %                                                                             %
   20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   21 
   22 
   23 % Program functions chapter.
   24 %%%%%%%%%%%%%%%%%%%%%%%%%%%%
   25 
   26 \chapter{Alphabetical listing of user functions}
   27 
   28 The following is a listing with descriptions of all the user functions\index{user functions} available within the relax prompt and scripting environments.
   29 These are simply an alphabetical list of the docstrings which can normally be viewed in prompt mode by typing \prompt{help(function)}\index{help system}.
   30 
   31 
   32 
   33 
   34 % A warning about the formatting.
   35 %~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   36 
   37 \section{A warning about the formatting}
   38 
   39 The following documentation of the user functions\index{user functions} has been automatically generated by a script which extracts and formats the docstring associated with each function.
   40 There may therefore be instances where the formatting has failed or where there are inconsistencies.
   41 
   42 
   43 
   44 % The list of functions.
   45 %~~~~~~~~~~~~~~~~~~~~~~~
   46 
   47 \section{The list of functions}
   48 
   49 Each user function\index{user functions} is presented within it's own subsection with the documentation broken into multiple parts:  the synopsis, the default arguments, and the sections from the function's docstring.
   50 
   51 
   52 % The synopsis.
   53 \subsection{The synopsis}
   54 
   55 The synopsis presents a brief description of the function.
   56 It is taken as the first line of the docstring when browsing the help system\index{help system}.
   57 
   58 
   59 % Defaults.
   60 \subsection{Defaults}
   61 
   62 This section lists all the arguments taken by the function and their default values.
   63 To invoke the function type the function name then in brackets type a comma separated list of arguments.
   64 
   65 The first argument printed is always `self' but you can safely ignore it.
   66 `self' is part of the object oriented programming within Python and is automatically prefixed to the list of arguments you supply.
   67 Therefore you can't provide `self' as the first argument even if you do try.
   68 
   69 
   70 % Docstring sectioning.
   71 \subsection{Docstring sectioning}
   72 
   73 All other sections are created from the sectioning of the user function docstring.
   74 
   75 
   76 \begin{latexonly}
   77    \newpage
   78    \raggedbottom
   79    \twocolumn
   80    {\scriptsize
   81    \input{docstring}
   82    }
   83    \onecolumn
   84 \end{latexonly}
   85 \begin{htmlonly}
   86    \input{docstring}
   87 \end{htmlonly}