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

DOC: Rename Gallery example for GMT logo #3856

Merged
merged 5 commits into from
Mar 19, 2025
Merged

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

In case we have a separate gallery example for the PyGMT logo in the future, I feel it makes sense to rename the already existing gallery example for the GMT logo and adjust the title to be more specific.

Also rewrap to the maximum allowed line length, which seems to be extended in the last ruff release, and is now 88 characters.

Preview:

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Mar 17, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 17, 2025
@seisman
Copy link
Member

seisman commented Mar 17, 2025

Actually, I'm debating if we should combine the pygmtlogo function into the Figure.logo method. If yes, then perhaps it's not necessary to rename this gallery example. In other words, let's keep this PR opened until we finalize the pygmt logo.

@yvonnefroehlich yvonnefroehlich marked this pull request as draft March 17, 2025 16:40
@yvonnefroehlich
Copy link
Member Author

Actually, I'm debating if we should combine the pygmtlogo function into the Figure.logo method. If yes, then perhaps it's not necessary to rename this gallery example. In other words, let's keep this PR opened until we finalize the pygmt logo.

I am also fine with having a combined method for both logos! In this case we will probably have a combined gallery example showing both logos. I think it make sense to focus in PR #3849 on the code of the extend or new method. For the case of a combined method, we can maybe use this PR to extend the current gallery example? For now, I set this PR to draft.


A bit off topic: In the gallery example for Figure.image (https://www.pygmt.org/dev/gallery/images/image.html) we use a PNG image of the GMT logo (vie URL). I feel it would be nice to find another image for this example as it is a bit redundant to the example for Figure.logo?

@seisman
Copy link
Member

seisman commented Mar 19, 2025

A bit off topic: In the gallery example for Figure.image (https://www.pygmt.org/dev/gallery/images/image.html) we use a PNG image of the GMT logo (vie URL). I feel it would be nice to find another image for this example as it is a bit redundant to the example for Figure.logo?

Yes, we just need to find another image and replace the GMT one.

@seisman
Copy link
Member

seisman commented Mar 19, 2025

Actually, I'm debating if we should combine the pygmtlogo function into the Figure.logo method. If yes, then perhaps it's not necessary to rename this gallery example. In other words, let's keep this PR opened until we finalize the pygmt logo.

I am also fine with having a combined method for both logos! In this case we will probably have a combined gallery example showing both logos. I think it make sense to focus in PR #3849 on the code of the extend or new method. For the case of a combined method, we can maybe use this PR to extend the current gallery example? For now, I set this PR to draft.

Actually, even if we decide to combine the pygmt logo into the Figure.logo method, we can still have separete gallery examples for the two logos. In the gallery example for the PyGMT logo, we can show PyGMT logos in different styles (light/dark, cicular/hex, with/without wordmarks).

@seisman seisman added this to the 0.15.0 milestone Mar 19, 2025
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2025
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2025
@seisman seisman marked this pull request as ready for review March 19, 2025 10:16
@seisman seisman merged commit 52c385f into main Mar 19, 2025
11 checks passed
@seisman seisman deleted the update-name-gallery-logo branch March 19, 2025 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants