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
Fix documentation warnings #1108
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4432,8 +4432,8 @@ def legend(self, *args, **kwargs): | |
instance. If *prop* is a dictionary, a new instance will be | ||
created with *prop*. If *None*, use rc settings. | ||
|
||
*fontsize*: [ size in points | 'xx-small' | 'x-small' | 'small' | | ||
'medium' | 'large' | 'x-large' | 'xx-large' ] | ||
*fontsize*: [ size in points | 'xx-small' | 'x-small' | | ||
'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ] | ||
Set the font size. May be either a size string, relative to | ||
the default font size, or an absolute font size in points. This | ||
argument is only used if prop is not specified. | ||
|
@@ -5602,17 +5602,17 @@ def boxplot(self, x, notch=False, sym='b+', vert=True, whis=1.5, | |
|
||
Returns a dictionary mapping each component of the boxplot | ||
to a list of the :class:`matplotlib.lines.Line2D` | ||
instances created. That disctionary has the following keys | ||
instances created. That dictionary has the following keys | ||
(assuming vertical boxplots): | ||
boxes: the main body of the boxplot showing the quartiles | ||
and the median's confidence intervals if enabled. | ||
medians: horizonal lines at the median of each box. | ||
whiskers: the vertical lines extending to the most extreme, | ||
non-outlier data points. | ||
caps: the horizontal lines at the ends of the whiskers. | ||
fliers: points representing data that extend beyone the | ||
whiskers (outliers). | ||
|
||
- boxes: the main body of the boxplot showing the quartiles | ||
and the median's confidence intervals if enabled. | ||
- medians: horizonal lines at the median of each box. | ||
- whiskers: the vertical lines extending to the most extreme, | ||
n-outlier data points. | ||
- caps: the horizontal lines at the ends of the whiskers. | ||
- fliers: points representing data that extend beyone the | ||
whiskers (outliers). | ||
|
||
**Example:** | ||
|
||
|
@@ -7828,6 +7828,8 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None, | |
ax.hist(12+3*np.random.randn(1000), label='women', alpha=0.5) | ||
ax.legend() | ||
|
||
. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ??? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When you have a literal block, you have to have a closing point at the same level on indentation from where it started. |
||
|
||
kwargs are used to update the properties of the | ||
:class:`~matplotlib.patches.Patch` instances returned by *hist*: | ||
|
||
|
@@ -8121,23 +8123,35 @@ def hist2d(self, x, y, bins = 10, range=None, normed=False, weights=None, | |
hist2d(x, y, bins = None, range=None, weights=None, cmin=None, cmax=None **kwargs) | ||
|
||
Make a 2d histogram plot of *x* versus *y*, where *x*, | ||
*y* are 1-D sequences of the same length | ||
*y* are 1-D sequences of the same length. | ||
|
||
The return value is (counts,xedges,yedges,Image) | ||
The return value is ``(counts, xedges, yedges, Image)``. | ||
|
||
Optional keyword arguments: | ||
*bins*: [None | int | [int, int] | array_like | [array, array]] | ||
|
||
The bin specification: | ||
If int, the number of bins for the two dimensions (nx=ny=bins). | ||
If [int, int], the number of bins in each dimension (nx, ny = bins). | ||
If array_like, the bin edges for the two dimensions (x_edges=y_edges=bins). | ||
If [array, array], the bin edges in each dimension (x_edges, y_edges = bins). | ||
|
||
- If int, the number of bins for the two dimensions | ||
(nx=ny=bins). | ||
|
||
- If [int, int], the number of bins in each dimension | ||
(nx, ny = bins). | ||
|
||
- If array_like, the bin edges for the two dimensions | ||
(x_edges=y_edges=bins). | ||
|
||
- If [array, array], the bin edges in each dimension | ||
(x_edges, y_edges = bins). | ||
|
||
The default value is 10. | ||
|
||
*range*: [*None* | array_like shape(2,2)] | ||
The leftmost and rightmost edges of the bins along each dimension (if not specified | ||
explicitly in the bins parameters): [[xmin, xmax], [ymin, ymax]]. All values outside of | ||
this range will be considered outliers and not tallied in the histogram. | ||
The leftmost and rightmost edges of the bins along each | ||
dimension (if not specified explicitly in the bins | ||
parameters): [[xmin, xmax], [ymin, ymax]]. All values | ||
outside of this range will be considered outliers and not | ||
tallied in the histogram. | ||
|
||
*normed*:[True|False] | ||
Normalize histogram. | ||
|
@@ -8147,12 +8161,15 @@ def hist2d(self, x, y, bins = 10, range=None, normed=False, weights=None, | |
An array of values w_i weighing each sample (x_i, y_i). | ||
|
||
*cmin* : [None| scalar] | ||
All bins that has count less than cmin will not be displayed | ||
and these count values in the return value count histogram will also be set to nan upon return | ||
All bins that has count less than cmin will not be | ||
displayed and these count values in the return value | ||
count histogram will also be set to nan upon return | ||
|
||
*cmax* : [None| scalar] | ||
All bins that has count more than cmax will not be displayed (set to none before passing to imshow) | ||
and these count values in the return value count histogram will also be set to nan upon return | ||
All bins that has count more than cmax will not be | ||
displayed (set to none before passing to imshow) and | ||
these count values in the return value count histogram | ||
will also be set to nan upon return | ||
|
||
Remaining keyword arguments are passed directly to :meth:pcolorfast | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Intentional (I've not been following
trisurf
/trisurface
)?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell, this was a typo in the docs. There has never been a method called
trisurface
.