delta/python-packages/numpy.git/doc/example.py, branch main

MAINT: Rm numpydoc remnant example docstring.

2022-09-25T23:49:06+00:00

MAINT: Remove unnecessary 'from future import ...' statements

2020-01-03T15:48:11+00:00

As numpy is Python 3 only, these import statements are now unnecessary
and don't alter runtime behavior.

TST: run refguide-check on rst files in doc/*

2019-10-17T16:31:06+00:00

PEP8 fixes

2016-05-02T14:54:48+00:00

DOC: Fix mismatched variable names in docstrings.

2016-02-16T01:20:18+00:00

ENH: Allow unnamed return values in Returns section of doc string

2013-06-25T05:29:56+00:00

Developers usually only need the type of a return value
followed by a brief description. However, in some cases
providing a name for a return value can make the documentation
clearer. This enhancement changes the format of the Returns
section such that the type is required, and the name is
optional:

    Returns
    -------
    int
        Description of anonymous integer return value.
    x : str
        Description of string return value named `x`.

With this change, if a colon is not present, then the entire
line is interpreted as the return type. In all other cases,
the Returns section is interpreted according to the current
rules.

Consistent with the current format, if a colon is present, then
the text to the left of the colon is interpreted as the name;
and the text to the right of the colon is interpreted as the
type. This makes the proposed change backwards compatible with
existing documentation.

2to3: Apply `print` fixer.

2013-04-06T19:25:26+00:00

Add `print_function` to all `from __future__ import ...` statements
and use the python3 print function syntax everywhere.

Closes #3078.

2to3: Use absolute imports.

2013-03-28T14:43:26+00:00

The new import `absolute_import` is added the `from __future__ import`
statement and The 2to3 `import` fixer is run to make the imports
compatible. There are several things that need to be dealt with to make
this work.

1) Files meant to be run as scripts run in a different environment than
files imported as part of a package, and so changes to those files need
to be skipped. The affected script files are:

    * all setup.py files
    * numpy/core/code_generators/generate_umath.py
    * numpy/core/code_generators/generate_numpy_api.py
    * numpy/core/code_generators/generate_ufunc_api.py

2) Some imported modules are not available as they are created during
the build process and consequently 2to3 is unable to handle them
correctly. Files that import those modules need a bit of extra work.
The affected files are:

    * core/__init__.py,
    * core/numeric.py,
    * core/_internal.py,
    * core/arrayprint.py,
    * core/fromnumeric.py,
    * numpy/__init__.py,
    * lib/npyio.py,
    * lib/function_base.py,
    * fft/fftpack.py,
    * random/__init__.py

Closes #3172

2to3: Put `from future import division in every python file.

2013-03-01T18:22:47+00:00

This should be harmless, as we already are division clean. However,
placement of this import takes some care. In the future a script
can be used to append new features without worry, at least until
such time as it exceeds a single line. Having that ability will
make it easier to deal with absolute imports and printing updates.

DOC: Remove the advice to 'import scipy as sp' from the documentation.

2011-04-02T02:25:17+00:00

Correct a statement about how doctest namespaces are initialized in scipy.