-
Notifications
You must be signed in to change notification settings - Fork 90
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
Parallexaxis doc #249
Parallexaxis doc #249
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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.
It looks like there is overlap between the Parameters and Attributes sections. I don't think this is ideal. See also the readthedocs build.
Did you actually change anything on the outputspace_exploration_lakeproblem.ipynb? If not, please clean up (by discarding those changes)
Also please make the PR title more descriptive (and in imperative mood).
|
||
Attributes | ||
---------- | ||
limits : DataFrame |
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.
Add a description of limits
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.
added the description from the parameters part
ema_workbench/analysis/parcoords.py
Outdated
set of Axes that are to be shown flipped | ||
axis_labels : list of str | ||
fontsize : int | ||
normalizer : MinMaxScaler instance |
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.
Add a description of normalizer
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 made this an implementation detail and removed it from the documentation. It is not part of the public API so you don't want to mess with the normalizer.
labels associated with lines | ||
|
||
|
||
The basic setup of the Parallel Axis plot is a row of mpl Axes instances, with all whitespace |
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.
Should this line have a header, since from here class methods are discussed?
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.
moved it into Notes which is the proper place for implementation details
I can't figure out how to discard that change. It indeed should not be there. I'll fix the rest. Note that the attributes and parameters can overlap. Parameters documents the arguments for the |
This reverts commit 9e729a0.
Looks good! Please squash while merging and cleanup the commit message and body while merging. |
Details the attributes available on ParallelAxis. closes #141
closes #141