Skip to content

Use Axes instead of axes in the docs. #18726

Closed as not planned
Closed as not planned
@timhoffm

Description

@timhoffm

Problem

From #18707 (comment):

Using lower-case "axes" in docstrings such as

Return whether any artists have been added to the axes.

is slightly ambiguous due to Axes being a special concept in Matplotlib not matching the plain english meaning.

Suggested Improvement

Always use "Axes" when referring to an Axes but not wanting to link to the class, .i.e.

Return whether any artists have been added to the Axes.

Note: This is a different compared to "figure".

Cases that should not become uppercase, include in particular

  • "axes" as a simple plural of axis
  • compound words like "axes space", "axes coordinates"

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentationstatus: closed as inactiveIssues closed by the "Stale" Github Action. Please comment on any you think should still be open.status: inactiveMarked by the “Stale” Github Action

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions