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

Minor improvement of docs of gallery example "Colorbars" #2440

Merged
merged 3 commits into from
Mar 20, 2023

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

For context please see #2395 (comment) and #2395 (comment).

Related to issue #2437

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.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@yvonnefroehlich yvonnefroehlich added enhancement Improving an existing feature skip-changelog Skip adding Pull Request to changelog labels Mar 18, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.9.0 milestone Mar 18, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 18, 2023
@seisman
Copy link
Member

seisman commented Mar 19, 2023

I don't think the changes are accurate. For frames with non-rectangle boundaries, using jBL doesn't place the colorbar inside the frame boundary.

>>> import pygmt
>>> fig = pygmt.Figure()
>>> fig.basemap(region="g", frame=True, projection="H10c")
>>> fig.colorbar(position="jBL+w3c+h", cmap="turbo", frame=True)
>>> fig.show()

map

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Mar 19, 2023

I don't think the changes are accurate. For frames with non-rectangle boundaries, using jBL doesn't place the colorbar inside the frame boundary.

That's a good point! But based on this also the old formulation "map frame" is not accurate. Maybe "bounding box" is the precise term here? Please see commit 8b463f6.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2023
@seisman seisman merged commit 43357b4 into main Mar 20, 2023
@seisman seisman deleted the improve-gallery-colorbar-docs branch March 20, 2023 13:40
@seisman seisman added documentation Improvements or additions to documentation and removed final review call This PR requires final review and approval from a second reviewer enhancement Improving an existing feature labels Mar 20, 2023
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.

None yet

3 participants