Add bfit bolditalic tex cmd by devRD · Pull Request #25359 · matplotlib/matplotlib

devRD · 2023-03-01T18:56:01Z

PR Summary

Fixes #19393
Adds support for bfit command in mathtext for bold italic

PR Checklist

Documentation and Tests

Has pytest style unit tests (and pytest passes)
Documentation is sphinx and numpydoc compliant (the docs should build without error).
New plotting related features are documented with examples.

Release Notes

New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

anntzer · 2023-03-02T09:20:17Z

Is that only implemented for stix? Do dejavu & cm also need their own thing?

devRD · 2023-03-03T05:31:48Z

Looks like dejavu and cm require their own mappings.

rcomer · 2023-03-06T09:33:28Z

lib/matplotlib/tests/test_mathtext.py

    (['mathrm'], all),
    (['mathbf'], all),
    (['mathit'], all),
+    (['mathbfit'], all),


The comment just above this list says “Add new tests at the end.” Looking at the failing tests themselves, it looks like the images are numbered according to the index in the list. So I think you just need to move your new entry to the end of the list.

oscargus · 2023-03-09T09:18:21Z

Thanks for this! I think it is a great addition!

Some questions:

Will it be clear from the documentation that this is supported? (I wasn't aware of the mathbfit command earlier so would not have guessed that was the way to obtain it.) I think a what's new note is worthwhile as well.
Am I right in assuming that \mathbfit{foo} is the way to obtain it and that \mathbf{\mathit{foo}} is not working? Would it be possible to make it work? It seems from the tests that e.g. \mathbf{\mathsf{bar}} works?
(Now, none of those works in standard LaTeX so maybe not a big thing if only one works.)
Should one also add an alias for \boldsymbol which basically is a way to obtain the same result and maybe more people(?) use?

Note that apart from maybe the first bullet, these are not things that must be included in this PR. Just wanted to open the discussion.

oscargus · 2023-03-09T09:22:05Z

This is probably a good location to document it:
https://matplotlib.org/stable/tutorials/text/mathtext.html#fonts

devRD · 2023-03-10T08:03:43Z

Hi @oscargus,

Thank you for the review! I have tried replying to your comments below:

I have updated the \mathbfit command in the docs font section in a new commit from the link you shared. The what's new section still needs to be updated.
Currently, \mathbfit{bar} is the preferred way to add bold-italic font. The \mathbf{\mathit{bar}} does not apply bold-italic, just derives the innermost style to use on the text.
At present, the \mathbfit command is deriving a stylistic change for dejavu and dejavusans fonts and the Unicode mapping for stix
As you mentioned making a \boldsymbol alias to \mathbfit would probably be the way to go because I found that the bm package, which provides \boldsymbol command conflicts with the Unicode-math package. It can be added in a future PR.

oscargus · 2023-03-10T09:02:06Z

Thanks! Would it also make sense to add it here? It seems to be working for stix right? (And then also for deja vu, but there is no special section for those I guess and maybe out of scope to add one.)

Also, for both entries here, it says "bold italic"?

devRD · 2023-03-10T09:17:05Z

I am not exactly sure how to add an alias for the \mathbfit command but I'll look into it. If you have any references I would appreciate it.

And, I believe the \mathbf command stating bold italic is incorrect as it just provides the boldface font. I can update both changes in a new commit.

oscargus · 2023-03-10T10:48:51Z

I am not exactly sure how to add an alias for the \mathbfit command but I'll look into it.

I just checked the code and I do not think that there is an easy way to do that...

Probably one will have to add a special command for this, both wrt parsing and a callback.

anntzer · 2023-03-11T13:44:04Z

@oscargus Per #19393 (comment), for consistency with latex, I think we should actually make \mathfoo{\mathbar{...}} not stack the styles, but just overwrite one another, and introducing \mathbfit for the stacked version seems correct.

devRD · 2023-03-17T08:10:37Z

Hi, @rcomer @oscargus @anntzer

Could you please review this patch and let me know if there are any further modifications required?

rcomer · 2023-03-17T09:03:41Z

I'm afraid I don't have the expertise to review this one.

oscargus · 2023-03-17T10:20:50Z

I think that the tutorial should be updated a bit further as discussed above (at least add it to the Stix section).

I'm also wondering if #mathtext.bfit:sans is the correct default rcParam, but I do not know exactly how that works. (I'd guess something like #mathtext.bfit:sans:italic:bold?)

Code-wise it looks good AFAICT.

oscargus · 2023-03-17T10:28:10Z

lib/matplotlib/mpl-data/matplotlibrc

 ## settings which map a TeX font name to a fontconfig font pattern.  (These
 ## settings are not used for other font sets.)
 #mathtext.bf:  sans:bold
+#mathtext.bfit:sans


Suggested change

#mathtext.bfit:sans

#mathtext.bfit: sans:italic:bold

This is what I think is a more correct default.

galleries/tutorials/text/mathtext.py

oscargus

Just some minor details, but all-in-all looking good!

oscargus · 2023-03-20T21:11:11Z

doc/users/next_whats_new/updated_mathtext.rst

@@ -0,0 +1,14 @@
+Bold-italic cmd ``\mathbfit``


Suggested change

Bold-italic cmd ``\mathbfit``

Bold-italic mathtext command ``\mathbfit``

oscargus · 2023-03-20T21:11:36Z

doc/users/next_whats_new/updated_mathtext.rst

+Bold-italic cmd ``\mathbfit``
+-----------------------------------------------------
+
+Supports use of bold-italic font style in Mathtext using the *\mathbfit{}* command:


Suggested change

Supports use of bold-italic font style in Mathtext using the *\mathbfit{}* command:

Supports use of bold-italic font style in mathtext using the ``\mathbfit{}`` command:

oscargus · 2023-03-20T21:12:01Z

galleries/users_explain/text/mathtext.py

    ``\mathfrak{Fraktur}``           :math-stix:`\mathfrak{Fraktur}`
    ``\mathsf{sansserif}``           :math-stix:`\mathsf{sansserif}`
    ``\mathrm{\mathsf{sansserif}}``  :math-stix:`\mathrm{\mathsf{sansserif}}`
+    ``\mathbfit{bolditalic}``        :math-stix:`\mathbfit{bolditalic}}`


Suggested change

``\mathbfit{bolditalic}`` :math-stix:`\mathbfit{bolditalic}}`

``\mathbfit{bolditalic}`` :math-stix:`\mathbfit{bolditalic}`

devRD · 2023-03-23T18:15:52Z

Hi @oscargus, I have updated the PR with the suggestions. Please let me know if anything else needs to be updated.

oscargus

Thanks!

A reminder to whoever may merge this to squash the commits. (@devRD if you know how to squash, please do.)

lib/matplotlib/_mathtext.py

lib/matplotlib/_mathtext_data.py

lib/matplotlib/tests/test_mathtext.py

anntzer

Extremely minor nits, but otherwise lgtm.

devRD · 2023-04-21T05:49:07Z

Hi all!
Thank you for the reviews. I have made the changes and rebased to the current main.

anntzer added the topic: text/mathtext label Mar 2, 2023

rcomer reviewed Mar 6, 2023

View reviewed changes

devRD marked this pull request as ready for review March 9, 2023 07:45

oscargus reviewed Mar 17, 2023

View reviewed changes

galleries/tutorials/text/mathtext.py Outdated Show resolved Hide resolved

devRD force-pushed the combotex branch from fe9b466 to 46e2606 Compare March 17, 2023 18:50

devRD requested a review from oscargus March 19, 2023 19:29

oscargus reviewed Mar 20, 2023

View reviewed changes

oscargus approved these changes Mar 23, 2023

View reviewed changes

devRD force-pushed the combotex branch from 0c99dcb to 1e7da72 Compare March 24, 2023 07:51

oscargus added the status: needs review label Apr 7, 2023

oscargus mentioned this pull request Apr 7, 2023

[ENH]: Support for \boldsymbol #25643

Closed

devRD mentioned this pull request Apr 11, 2023

boldsymbol support for mathtext #25661

Merged

6 tasks

anntzer reviewed Apr 20, 2023

View reviewed changes

lib/matplotlib/_mathtext.py Outdated Show resolved Hide resolved

anntzer reviewed Apr 20, 2023

View reviewed changes

lib/matplotlib/_mathtext_data.py Outdated Show resolved Hide resolved

anntzer reviewed Apr 20, 2023

View reviewed changes

lib/matplotlib/tests/test_mathtext.py Outdated Show resolved Hide resolved

anntzer approved these changes Apr 20, 2023

View reviewed changes

Add bfit bolditalic tex command

08aabca

devRD force-pushed the combotex branch from 1e7da72 to 08aabca Compare April 21, 2023 05:48

anntzer approved these changes Apr 21, 2023

View reviewed changes

anntzer removed the status: needs review label Apr 21, 2023

anntzer added this to the v3.8.0 milestone Apr 21, 2023

anntzer merged commit 70e674e into matplotlib:main Apr 21, 2023

	Bold-italic cmd ``\mathbfit``
	Bold-italic mathtext command ``\mathbfit``

	Supports use of bold-italic font style in Mathtext using the \mathbfit{} command:
	Supports use of bold-italic font style in mathtext using the ``\mathbfit{}`` command:

	``\mathbfit{bolditalic}`` :math-stix:`\mathbfit{bolditalic}}`
	``\mathbfit{bolditalic}`` :math-stix:`\mathbfit{bolditalic}`

Uh oh!

Conversation

devRD commented Mar 1, 2023

PR Summary

PR Checklist

Uh oh!

anntzer commented Mar 2, 2023

Uh oh!

devRD commented Mar 3, 2023

Uh oh!

rcomer Mar 6, 2023

Choose a reason for hiding this comment

Uh oh!

oscargus commented Mar 9, 2023

Uh oh!

oscargus commented Mar 9, 2023

Uh oh!

devRD commented Mar 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oscargus commented Mar 10, 2023

Uh oh!

devRD commented Mar 10, 2023

Uh oh!

oscargus commented Mar 10, 2023

Uh oh!

anntzer commented Mar 11, 2023

Uh oh!

devRD commented Mar 17, 2023

Uh oh!

rcomer commented Mar 17, 2023

Uh oh!

oscargus commented Mar 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oscargus Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

oscargus left a comment

Choose a reason for hiding this comment

Uh oh!

oscargus Mar 20, 2023

Choose a reason for hiding this comment

Uh oh!

oscargus Mar 20, 2023

Choose a reason for hiding this comment

Uh oh!

oscargus Mar 20, 2023

Choose a reason for hiding this comment

Uh oh!

devRD commented Mar 23, 2023

Uh oh!

oscargus left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anntzer left a comment

Choose a reason for hiding this comment

Uh oh!

devRD commented Apr 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

devRD commented Mar 10, 2023 •

edited

Loading

oscargus commented Mar 17, 2023 •

edited

Loading

oscargus left a comment •

edited

Loading