Skip to content

axisartist documentation missing for classes and functions, and has typos #19100

Closed as not planned
@jasondet

Description

@jasondet

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: ax.axis["bottom"].major_ticks.set_ticks_out(True) should be ax.axis["bottom"].major_ticks.set_tick_out(True) (remove 's' after 'tick' in 'set_tick_out') done

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

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions