matplotlib / matplotlib/matplotlib

[MNT]: Terminology: artist property

Open
#22,460 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

### Summary

Matplotlib uses "property" as a technical term for aspects of an Artist that can be queried using a `get_()` method. This is confusing because *property* has a dedicated meaning within python. Examples:

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.artist.Artist.properties.html

> Return a dictionary of all the properties of the artist.

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.artist.Artist.set.html:

> Set multiple properties at once. Supported properties are

### Proposed fix

I think our properties are older than python's, but we can't make them change :stuck_out_tongue_winking_eye:. I therefore propose that we use a different term in our documentation. Suggestion: *artist property*.

Inspired by #22451.

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 documentation for matplotlib.artist.Artist.properties and Artist.set linked in the issue, then search the documentation for uses of “property” referring to Artist properties. The work is done when those references consistently use the chosen terminology without changing Python’s technical meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
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.