Skip to content

DOC: Show and correct default alignment parameters in text.py #27346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oscargus merged 9 commits into from
Dec 13, 2023
Merged

DOC: Show and correct default alignment parameters in text.py #27346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7fd4bb5
Show and correct default alignment parameters in text.py
jsalsman Nov 19, 2023
b4461ba
Update text.py: line too long
jsalsman Nov 19, 2023
5c17089
Show defaults in text_alignment.py
jsalsman Nov 19, 2023
1b4f3e1
Make setter method defaults match new docstrings in text.py
jsalsman Nov 22, 2023
1f217b1
IDL text alignment set_ method defaults for text.pyi
jsalsman Nov 22, 2023
9784f01
revert interface defaults in text.pyi
jsalsman Nov 23, 2023
c3949bf
revert defaults in alignment set_ methods text.py
jsalsman Nov 23, 2023
5950041
Document text alignment defaults in _axes.py
jsalsman Nov 23, 2023
446a3ba
rm trailing whitespace in _axes.py
jsalsman Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion galleries/examples/text_labels_and_annotations/text_alignment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
==============

Texts are aligned relative to their anchor point depending on the properties
``horizontalalignment`` and ``verticalalignment``.
``horizontalalignment`` (default: ``left``) and ``verticalalignment``
(default: ``baseline``.)

.. redirect-from:: /gallery/pyplots/text_layout

Expand Down
5 changes: 4 additions & 1 deletion lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,10 @@ def text(self, x, y, s, fontdict=None, **kwargs):
"""
Add text to the Axes.

Add the text *s* to the Axes at location *x*, *y* in data coordinates.
Add the text *s* to the Axes at location *x*, *y* in data coordinates,
with a default ``horizontalalignment`` on the ``left`` and
``verticalalignment`` at the ``baseline``. See
:doc:`/gallery/text_labels_and_annotations/text_alignment`.

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def __init__(self,

The text is aligned relative to the anchor point (*x*, *y*) according
to ``horizontalalignment`` (default: 'left') and ``verticalalignment``
(default: 'bottom'). See also
(default: 'baseline'). See also
:doc:`/gallery/text_labels_and_annotations/text_alignment`.

While Text accepts the 'label' keyword argument, by default it is not
Expand Down Expand Up @@ -1251,7 +1251,7 @@ def set_verticalalignment(self, align):

Parameters
----------
align : {'bottom', 'baseline', 'center', 'center_baseline', 'top'}
align : {'baseline', 'bottom', 'center', 'center_baseline', 'top'}
"""
Copy link
Contributor

@StefRe StefRe Nov 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above: there is no default value here as the align parameter is not optional.

_api.check_in_list(
['top', 'bottom', 'center', 'baseline', 'center_baseline'],
Expand Down