matplotlib / matplotlib/matplotlib

tool manager functionality is not well documented

Open
#19,437 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation keep MEP: MEP22
Dominant language
Python
Stars
23.2k
Forks
8.5k
Avg merge
1d 6h
Merged PRs (30d)
66

Description

I'm looking at the page at https://matplotlib.org/3.1.0/gallery/user_interfaces/toolmanager_sgskip.html

The example is nice, but would be much more helpful if it came with some explanations. I'm unclear about several things. In particular: (1) When do the various methods in `GroupHideTool` get invoked? (2) What does the augmented toolbar look like? (3) What are the capabilities and limitations of the tool manager?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the toolmanager_sgskip.html gallery example linked in the issue and inspect how GroupHideTool is used. Document when its methods are invoked, show what the augmented toolbar looks like, and explain the tool manager's capabilities and limitations. Done means the example page answers all three questions clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.