Skip to content
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

Jump to bottom

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

Merged
merged 9 commits into from
Dec 13, 2023
Merged

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

Changes from 2 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 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 @@ -1002,7 +1002,7 @@ def set_horizontalalignment(self, align):

Parameters
----------
align : {'left', 'center', 'right'}
align : {'left', 'center', 'right'}, default: left
Copy link
Contributor

@StefRe StefRe Nov 21, 2023 •
edited

Choose a reason for hiding this comment

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

There is no default value here as the align parameter is not optional (i.e. you can't call set_horizontalalignment() and expect that it sets the alignement to left)

Copy link
Contributor Author

@jsalsman jsalsman Nov 22, 2023 •
edited

Choose a reason for hiding this comment

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

But if you don't call the setter, the value is left. How to convey that in the docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

The default values are (implicitly) documented in the __init__ method (class signature).

Further, matplotlib follows numpydoc conventions:

When a parameter can only assume one of a fixed set of values, those values can be listed in braces, with the default appearing first:

order : {'C', 'F', 'A'}
   Description of `order`.

So the explicit description of the default value is not required in this case, we'd just need to move the baseline entry for verticalalignment to the first position.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

move the baseline entry for verticalalignment to the first position.

Done.

"""
_api.check_in_list(['center', 'right', 'left'], align=align)
self._horizontalalignment = align
Expand Down Expand Up @@ -1251,7 +1251,8 @@ def set_verticalalignment(self, align):

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

@StefRe StefRe Nov 21, 2023 •
edited

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