Example#

Source#

"""Docstring for the example.py module.Modules names should have short, all-lowercase names.  The module name mayhave underscores if this improves readability.Every module should have a docstring at the very top of the file.  Themodule's docstring may extend over multiple lines.  If your docstring doesextend over multiple lines, the closing three quotation marks must be ona line by itself, preferably preceded by a blank line."""importos# standard library imports first# Do NOT import using *, e.g. from numpy import *## Import the module using##   import numpy## instead or import individual functions as needed, e.g##  from numpy import array, zeros## If you prefer the use of abbreviated module names, we suggest the# convention used by NumPy itself::importnumpyasnpimportmatplotlibasmplimportmatplotlib.pyplotasplt# These abbreviated names are not to be used in docstrings; users must# be able to paste and execute docstrings after importing only the# numpy module itself, unabbreviated.deffoo(var1,var2,*args,long_var_name="hi",only_seldom_used_keyword=0,**kwargs):r"""Summarize the function in one line.    Several sentences providing an extended description. Refer to    variables using back-ticks, e.g. `var`.    Parameters    ----------    var1 : array_like        Array_like means all those objects -- lists, nested lists, etc. --        that can be converted to an array.  We can also refer to        variables like `var1`.    var2 : int        The type above can either refer to an actual Python type        (e.g. ``int``), or describe the type of the variable in more        detail, e.g. ``(N,) ndarray`` or ``array_like``.    *args : iterable        Other arguments.    long_var_name : {'hi', 'ho'}, optional        Choices in brackets, default first when optional.    Returns    -------    type        Explanation of anonymous return value of type ``type``.    describe : type        Explanation of return value named `describe`.    out : type        Explanation of `out`.    type_without_description    Other Parameters    ----------------    only_seldom_used_keyword : int, optional        Infrequently used parameters can be described under this optional        section to prevent cluttering the Parameters section.    **kwargs : dict        Other infrequently used keyword arguments. Note that all keyword        arguments appearing after the first parameter specified under the        Other Parameters section, should also be described under this        section.    Raises    ------    BadException        Because you shouldn't have done that.    See Also    --------    numpy.array : Relationship (optional).    numpy.ndarray : Relationship (optional), which could be fairly long, in                    which case the line wraps here.    numpy.dot, numpy.linalg.norm, numpy.eye    Notes    -----    Notes about the implementation algorithm (if needed).    This can have multiple paragraphs.    You may include some math:    .. math:: X(e^{j\omega } ) = x(n)e^{ - j\omega n}    And even use a Greek symbol like :math:`\omega` inline.    References    ----------    Cite the relevant literature, e.g. [1]_.  You may also cite these    references in the notes section above.    .. [1] O. McNoleg, "The integration of GIS, remote sensing,       expert systems and adaptive co-kriging for environmental habitat       modelling of the Highland Haggis using object-oriented, fuzzy-logic       and neural-network techniques," Computers & Geosciences, vol. 22,       pp. 585-588, 1996.    Examples    --------    These are written in doctest format, and should illustrate how to    use the function.    >>> a = [1, 2, 3]    >>> print([x + 3 for x in a])    [4, 5, 6]    >>> print("a\nb")    a    b    """# After closing class docstring, there should be one blank line to# separate following codes (according to PEP257).# But for function, method and module, there should be no blank lines# after closing the docstring.

Rendered#

Docstring for the example.py module.

Modules names should have short, all-lowercase names. The module name mayhave underscores if this improves readability.

Every module should have a docstring at the very top of the file. Themodule’s docstring may extend over multiple lines. If your docstring doesextend over multiple lines, the closing three quotation marks must be ona line by itself, preferably preceded by a blank line.

example.foo(var1,var2,*args,long_var_name='hi',only_seldom_used_keyword=0,**kwargs)[source]#

Summarize the function in one line.

Several sentences providing an extended description. Refer tovariables using back-ticks, e.g.var.

Parameters:
var1array_like

Array_like means all those objects – lists, nested lists, etc. –that can be converted to an array. We can also refer tovariables likevar1.

var2int

The type above can either refer to an actual Python type(e.g.int), or describe the type of the variable in moredetail, e.g.(N,)ndarray orarray_like.

*argsiterable

Other arguments.

long_var_name{‘hi’, ‘ho’}, optional

Choices in brackets, default first when optional.

Returns:
type

Explanation of anonymous return value of typetype.

describetype

Explanation of return value nameddescribe.

outtype

Explanation ofout.

type_without_description
Other Parameters:
only_seldom_used_keywordint, optional

Infrequently used parameters can be described under this optionalsection to prevent cluttering the Parameters section.

**kwargsdict

Other infrequently used keyword arguments. Note that all keywordarguments appearing after the first parameter specified under theOther Parameters section, should also be described under thissection.

Raises:
BadException

Because you shouldn’t have done that.

See also

numpy.array

Relationship (optional).

numpy.ndarray

Relationship (optional), which could be fairly long, in which case the line wraps here.

numpy.dot,numpy.linalg.norm,numpy.eye

Notes

Notes about the implementation algorithm (if needed).

This can have multiple paragraphs.

You may include some math:

X(e^{j\omega } ) = x(n)e^{ - j\omega n}

And even use a Greek symbol like\omega inline.

References

Cite the relevant literature, e.g.[1]. You may also cite thesereferences in the notes section above.

[1]

O. McNoleg, “The integration of GIS, remote sensing,expert systems and adaptive co-kriging for environmental habitatmodelling of the Highland Haggis using object-oriented, fuzzy-logicand neural-network techniques,” Computers & Geosciences, vol. 22,pp. 585-588, 1996.

Examples

These are written in doctest format, and should illustrate how touse the function.

>>>a=[1,2,3]>>>print([x+3forxina])[4, 5, 6]>>>print("a\nb")ab
On this page

This Page