Skip to content

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

@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

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy