8000 DOC: RST definition list fixes by endolith · Pull Request #7626 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: RST definition list fixes #7626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
DOC: Fix some incorrect RST definition lists
  • Loading branch information
endolith committed May 12, 2016
commit eb8913d1a39e09b739a6e9449dc841a52ecbac37
13 changes: 9 additions & 4 deletions numpy/add_newdocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@
has_multi_index : bool
If True, the iterator was created with the "multi_index" flag,
and the property `multi_index` can be used to retrieve it.
index :
index
When the "c_index" or "f_index" flag was used, this property
provides access to the index. Raises a ValueError if accessed
and `has_index` is False.
Expand All @@ -273,10 +273,10 @@
An index which matches the order of iteration.
itersize : int
Size of the iterator.
itviews :
itviews
Structured view(s) of `operands` in memory, matching the reordered
and optimized iterator access pattern.
multi_index :
multi_index
When the "multi_index" flag was used, this property
provides access to the index. Raises a ValueError if accessed
accessed and `has_multi_index` is False.
Expand All @@ -288,7 +288,7 @@
The array(s) to be iterated over.
shape : tuple of ints
Shape tuple, the shape of the iterator.
value :
value
Value of `operands` at current iteration. Normally, this is a
tuple of array scalars, but if the flag "external_loop" is used,
it is a tuple of one dimensional arrays.
Expand Down Expand Up @@ -481,6 +481,11 @@ def luf(lamdaexpr, *args, **kwargs):
Amongst others, it has ``shape`` and ``nd`` properties, and
may be used as an iterator.

See Also
--------
broadcast_arrays
broadcast_to

Examples
--------
Manually adding two vectors, using broadcasting:
Expand Down
2 changes: 1 addition & 1 deletion numpy/lib/function_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def flip(m, axis):
----------
m : array_like
Input array.
axis: integer
axis : integer
Axis in array, which entries are reversed.


Expand Down
2 changes: 1 addition & 1 deletion numpy/lib/polynomial.py
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ def polyfit(x, y, deg, rcond=None, full=False, w=None, cov=False):
Polynomial coefficients, highest power first. If `y` was 2-D, the
coefficients for `k`-th data set are in ``p[:,k]``.

residuals, rank, singular_values, rcond :
residuals, rank, singular_values, rcond
Present only if `full` = True. Residuals of the least-squares fit,
the effective rank of the scaled Vandermonde coefficient matrix,
its singular values, and the specified value of `rcond`. For more
Expand Down
4 changes: 2 additions & 2 deletions numpy/lib/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -393,9 +393,9 @@ def _info(obj, output=sys.stdout):

Parameters
----------
obj: ndarray
obj : ndarray
Must be ndarray, not checked.
output:
output
Where printed output goes.

Notes
Expand Down
4 changes: 2 additions & 2 deletions numpy/polynomial/_polybase.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,13 +223,13 @@ class as self with identical domain and window. If so,

Returns
-------
coef:
coef
The coefficients of`other` if it is a compatible instance,
of ABCPolyBase, otherwise `other`.

Raises
------
TypeError:
TypeError
When `other` is an incompatible instance of ABCPolyBase.

"""
Expand Down
0