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.

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

subtitle kwarg to set_titles_and_labels #185

Merged
merged 6 commits into from
Jan 17, 2024
Merged

subtitle kwarg to set_titles_and_labels #185

merged 6 commits into from
Jan 17, 2024

Conversation

jukent
Copy link
Collaborator

@jukent jukent commented Jan 17, 2024

PR Summary

Adds a subtitle keyword argument to set_titles_and_labels by leveraging the fig.suptitle() function
Closes #52

PR Checklist

General

  • Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated
  • Add appropriate labels to this PR
  • Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

Documentation

  • Docstrings have been added to all new functions
  • Docstrings have been updated with any function changes
  • Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
  • User facing functions have been added to docs/user_api/index.rst under their module

Examples

  • Any new notebook examples added to docs/examples/ folder
  • Clear all notebook cells
  • New notebook files added to docs/examples.rst toctree
  • New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

@jukent jukent added the enhancement New feature or request label Jan 17, 2024
@jukent jukent marked this pull request as ready for review January 17, 2024 20:33
@jukent jukent requested a review from kafitzgerald January 17, 2024 20:33
Copy link
Collaborator

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

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

Looks good!

Should we add this to the usage example as well?

@jukent
Copy link
Collaborator Author

jukent commented Jan 17, 2024

Sure thing

@jukent jukent requested a review from kafitzgerald January 17, 2024 21:37
Copy link
Collaborator

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

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

There's something funky going on still with the example:
https://geocat-viz--185.org.readthedocs.build/en/185/examples/set_titles_and_labels.html

Looks like a minor typo

Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
@jukent jukent requested a review from kafitzgerald January 17, 2024 21:56
@jukent jukent merged commit e9b37d9 into NCAR:main Jan 17, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add subtitle capability to set_titles_and_lables
2 participants