Skip to content

[Doc]: text alignment defaults #27345

Closed
@jsalsman

Description

@jsalsman

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.pyplot.text.html

Problem

  • It would be fantastic if the default text horizontalalignment (left) and verticalalignment (baseline) were documented in matplotlib.pyplot.text.html please.
  • For reference, the defaults are not set in rcParams, but in the Text class at lib/matplotlib/text.py here:
def __init__(self,
             ...
             verticalalignment='baseline',
             horizontalalignment='left',
             ...
             ):

There are a few other similar excerpts in text.py for resetting defaults, etc.

Sorry I'm not skilled enough to do a PR myself. [Got it, I believe: #27346] Thank you for your kind consideration of this request.

Suggested improvement

  • alongside "horizontalalignment or ha"
    • change: {'left', 'center', 'right'}
    • to: {'left', 'center', 'right'}, default: left
  • alongside "verticalalignment or va"
    • change: {'bottom', 'baseline', 'center', 'center_baseline', 'top'}
    • to: {'bottom', 'baseline', 'center', 'center_baseline', 'top'}, default: baseline

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions