Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
[Doc] Improve axisartist documentation#27351
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| axes : `mpl_toolkits.axisartist.axislines.Axes` | ||
| nth_coord : {0, 1}, optional | ||
| Along which coordinate the value varies in 2D. 0: x-axis, 1: y-axis. | ||
| passingthrough_point : |
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.
Rename to "value" for consistency with the parent class?
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 was considering the other way around, sincepassingthrough_point gives some information about what it is used for. But with a good description (which it currently lacks...), value is probably easier to remember/spell etc.
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 think it would be much simpler to documentnth_coord andvalue (orpassingthrough_point, which is not even really well named as it's a scalar value, not a 2d point) together as something like "nth_coord = 0; value = v means to draw an axis atx=v;nth_coord = 1; value = v means to draw an axis aty=v". (By the way this suggests that your wording for nth_coord's doc is also "wrong"?)
| Parameters | ||
| ---------- | ||
| loc : ["left", "right", "top", "bottom"] | ||
| axis_direction : ["left", "right", "top", "bottom"], optional |
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.
just..., default: *loc*
PR summary
Some improvements to the axisartist documentation. Can be further improved, but at least providing a bit more info.
PR checklist