Skip to content

[Doc]: FontManager docs should mention the singleton is named fontManager #22586

Closed
@twm

Description

@twm

Documentation Link

https://matplotlib.org/devdocs/api/font_manager_api.html

Problem

The reference documentation for the FontManager class says that there is a singleton:

This module provides a single FontManager instance that can be shared across backends and platforms.

However, it doesn't mention that this singleton is named fontManager.

Suggested improvement

  • The docstring should clarify that the singleton is named fontManager, rather than implying that the FontManager class is a singleton:

    This module provides a single `FontManager` instance, `fontManager`, that is shared across backends and platforms.
  • The fontManager instance should be documented as a global variable:

    .. data:: fontManager
    
        The singleton instance of :class:`FontManager`

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions