Skip to content

Multicursor docstring missing a Parameters Section #19634

Closed

Description

@ianhi

Problem

The multicursor __init__ method doesn't have a docstring, so there is no documentation of it's parameters

def __init__(self, canvas, axes, useblit=True, horizOn=False, vertOn=True,
**lineprops):
self.canvas = canvas
self.axes = axes
self.horizOn = horizOn

Suggested Improvement

Add a docstring. In particular it seems that the xlim and ylim of the cursors are set by the last axis in axes so that should be explained in the docstring (or perhaps changed).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions