Skip to content

Silence some Sphinx warnings by rewriting docstrings. #3548

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.

Sign up for GitHub

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 8 commits into from
Sep 22, 2014
Merged

Silence some Sphinx warnings by rewriting docstrings. #3548

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b4fb455
Fix warning in lines.py
jenshnielsen Sep 18, 2014
fd558d9
Indent correctly in mlab
jenshnielsen Sep 19, 2014
b9ac3fc
silence warnings in art3d
jenshnielsen Sep 19, 2014
7dca5a0
Fix warnings in cbook
jenshnielsen Sep 19, 2014
52714d8
Fix warnings in _axes
jenshnielsen Sep 19, 2014
f28c204
fix rendering of warnings in mlab
jenshnielsen Sep 21, 2014
602176e
Improve rendering of title docs
jenshnielsen Sep 21, 2014
2f1fcde
docstring in trirefine
jenshnielsen Sep 21, 2014
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
Next Next commit
fix rendering of warnings in mlab
  • Loading branch information
@jenshnielsen
jenshnielsen committed Sep 21, 2014
commit f28c204d77c2bd033fc9396281748363ebcf6dac
20 changes: 13 additions & 7 deletions lib/matplotlib/mlab.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,9 +541,11 @@ def stride_windows(x, n, noverlap=None, axis=0):
Get all windows of x with length n as a single array,
using strides to avoid data duplication.

.. warning:: It is not safe to write to the output array. Multiple
elements may point to the same piece of memory, so modifying one value may
change others.
.. warning::

It is not safe to write to the output array. Multiple
elements may point to the same piece of memory,
so modifying one value may change others.

Call signature::

Expand Down Expand Up @@ -603,9 +605,11 @@ def stride_repeat(x, n, axis=0):
Repeat the values in an array in a memory-efficient manner. Array x is
stacked vertically n times.

.. warning:: It is not safe to write to the output array. Multiple
elements may point to the same piece of memory, so modifying one value may
change others.
.. warning::

It is not safe to write to the output array. Multiple
elements may point to the same piece of memory, so
modifying one value may change others.

Call signature::

Expand Down Expand Up @@ -1605,7 +1609,9 @@ def longest_ones(x):
def prepca(P, frac=0):
"""

WARNING: this function is deprecated -- please see class PCA instead
.. warning::

This function is deprecated -- please see class PCA instead

Compute the principal components of *P*. *P* is a (*numVars*,
*numObs*) array. *frac* is the minimum fraction of variance that a
Expand Down