10000 Reword FontProperties docstring. by anntzer · Pull Request #18863 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Reword FontProperties docstring. #18863

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
Merged
merged 1 commit into from
Nov 3, 2020
Merged

Reword FontProperties docstring. #18863

merged 1 commit into from
Nov 3, 2020

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Nov 1, 2020
  • Indicate each default property when it occurs, rather than at the end
    (where it's unclear what each instance of "normal" means); also fix
    the default size.
  • List supported math_fontfamilies using the same inline list as other
    properties, which avoids having and getting highlighted as a Python
    keyword in the rendered docs.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@anntzer
Reword FontProperties docstring.
ee00b9b 
- Indicate each default property when it occurs, rather than at the end
  (where it's unclear what each instance of "normal" means); also fix
  the default size.
- List supported math_fontfamilies using the same inline list as other
  properties, which avoids having `and` getting highlighted as a Python
  keyword in the rendered docs.
timhoffm
timhoffm approved these changes Nov 1, 2020
View reviewed changes
Copy link
Member
@timhoffm timhoffm left a comment •
edited
Loading

Choose a reason for hiding this comment

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

IMHO it would make sense to transform this into a regular Parameters section.

But not insisting since this is already a step better better as before.

@QuLogic QuLogic added this to the v3.4.0 milestone Nov 3, 2020
@QuLogic QuLogic merged commit 82e2f94 into matplotlib:master Nov 3, 2020
@anntzer anntzer deleted the dfp branch November 3, 2020 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation topic: text/fonts
Projects
None yet
Milestone
v3.4.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @timhoffm @QuLogic
0