-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Closed as not planned
Closed as not planned
Copy link
Labels
Documentationstatus: closed as inactiveIssues closed by the "Stale" Github Action. Please comment on any you think should still be open.Issues closed by the "Stale" Github Action. Please comment on any you think should still be open.status: inactiveMarked by the “Stale” Github ActionMarked by the “Stale” Github Actiontopic: mpl_toolkit
Description
Problem
I was trying to follow this example using axisartist but several of the main functions called there have no documentation that I could find via google or by clicking links in the existing documentation. In particular:
- I couldn't find documentation for
axisart.Subplot()
, at least not from the links in the toolkits page. Usage examples are given in the axisartist tutorial but for example what the heck are the "1, 1, 1" arguments?? I was able to guess that the return value was AxisArtist but it would be nice to have been told that. - The documentation for AxisArtist is missing documentation for
new_floating_axis()
. The axisartist.axis_artist docs page has a typo:doneax.axis["bottom"].major_ticks.set_ticks_out(True)
should beax.axis["bottom"].major_ticks.set_tick_out(True)
(remove 's' after 'tick' in 'set_tick_out')
Suggested Improvement
- add proper sphinx documentation for all classes in axistartist
- add proper sphinx documentation for all functions of all classes in axisartist
- check all code snippets in documentation for typos
Metadata
Metadata
Assignees
Labels
Documentationstatus: closed as inactiveIssues closed by the "Stale" Github Action. Please comment on any you think should still be open.Issues closed by the "Stale" Github Action. Please comment on any you think should still be open.status: inactiveMarked by the “Stale” Github ActionMarked by the “Stale” Github Actiontopic: mpl_toolkit