Skip to content

DOC: Remove Tick object details from artist tutorial#31692

Open
timhoffm wants to merge 1 commit into
matplotlib:mainfrom
timhoffm:doc-artist-tutorial
Open

DOC: Remove Tick object details from artist tutorial#31692
timhoffm wants to merge 1 commit into
matplotlib:mainfrom
timhoffm:doc-artist-tutorial

Conversation

@timhoffm
Copy link
Copy Markdown
Member

Closes #31682.

Don't explain the object structure and accessor methods to Tick objects and their constituent artists. Users should rarely use them as they are dynamically created and modified.

  • Remove the complete section on "Tick containers". Users really should access the individual parts through a Tick instance. The technical API still remains accessible in https://matplotlib.org/stable/api/axis_api.html#matplotlib.axis.Tick
  • Remove all the tick parts getter functions and instead point users to formatters, locators and tick_params.

Closes matplotlib#31682.

Don't explain the object structure and accessor methods to Tick objects
and their constituent artists. Users should rarely use them as they
are dynamically created and modified.

- Remove the complete section on "Tick containers". Users really should
  access the individual parts through a Tick instance. The technical
  API still remains accessible in
  https://matplotlib.org/stable/api/axis_api.html#matplotlib.axis.Tick
- Remove all the tick parts getter functions and instead point users
  to formatters, locators and tick_params.
@github-actions github-actions Bot added the Documentation: tutorials files in galleries/tutorials label May 17, 2026
@timhoffm timhoffm added this to the v3.11.0 milestone May 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: tutorials files in galleries/tutorials

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc]: Artist tutorial should not encourage working with tick objects

1 participant