-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
MEP10 - refactored hlines and vlines documentation #1795
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
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4c23c38
MEP10 - refactored hlines and vlines documentation
NelleV 58458de
Modified hline and vline examples to have only one file and linked th…
NelleV ec54a0b
DOC mentions kwargs in vlines and hlines
NelleV 0de3de8
DOC didn't render properly
NelleV File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
#!/usr/bin/env python | ||
|
||
""" | ||
Small demonstration of the hlines and vlines plots. | ||
""" | ||
|
||
from matplotlib import pyplot as plt | ||
from numpy import sin, exp, absolute, pi, arange | ||
from numpy.random import normal | ||
|
||
|
||
def f(t): | ||
s1 = sin(2 * pi * t) | ||
e1 = exp(-t) | ||
return absolute((s1 * e1)) + .05 | ||
|
||
|
||
t = arange(0.0, 5.0, 0.1) | ||
s = f(t) | ||
nse = normal(0.0, 0.3, t.shape) * s | ||
|
||
fig = plt.figure(figsize=(12, 6)) | ||
vax = fig.add_subplot(121) | ||
hax = fig.add_subplot(122) | ||
|
||
vax.plot(t, s + nse, 'b^') | ||
vax.vlines(t, [0], s) | ||
vax.set_xlabel('time (s)') | ||
vax.set_title('Vertical lines demo') | ||
|
||
hax.plot(s + nse, t, 'b^') | ||
hax.hlines(t, [0], s, lw=2) | ||
hax.set_xlabel('time (s)') | ||
hax.set_title('Horizontal lines demo') | ||
|
||
plt.show() |
This file contains hidden or 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 hidden or 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.
Have the contents of this now been included directly?
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.
Nope, this is lost. Using this trick doesn't work (it is not rendered properly), and numpydoc has no way to do introspection to spot that these are linecollection kwargs.
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.
I know that whether to continue to include these inline was controversial -- but I tend to fall on the side of not duplicating this information everywhere. If we do that, though, we need a clear link to the
LineProperties
class, and my suggested change for theReturns
section above does that.