File: add_newdocs.py

package info (click to toggle)
python-scipy 0.18.1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 75,464 kB
  • ctags: 79,406
  • sloc: python: 143,495; cpp: 89,357; fortran: 81,650; ansic: 79,778; makefile: 364; sh: 265
file content (30 lines) | stat: -rw-r--r-- 839 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
from numpy import add_newdoc

add_newdoc('scipy.odr', 'odr',
    """
    odr(fcn, beta0, y, x, we=None, wd=None, fjacb=None, fjacd=None, extra_args=None, ifixx=None, ifixb=None, job=0, iprint=0, errfile=None, rptfile=None, ndigit=0, taufac=0.0, sstol=-1.0, partol=-1.0, maxit=-1, stpb=None, stpd=None, sclb=None, scld=None, work=None, iwork=None, full_output=0)

    Low-level function for ODR.

    See Also
    --------
    ODR
    Model
    Data
    RealData

    Notes
    -----
    This is a function performing the same operation as the `ODR`,
    `Model` and `Data` classes together. The parameters of this
    function are explained in the class documentation.

    """)

add_newdoc('scipy.odr.__odrpack', '_set_exceptions',
    """
    _set_exceptions(odr_error, odr_stop)

    Internal function: set exception classes.

    """)