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

colorbar is missing documentation for "-I" and lacks a "shading" alias #749

Closed
MarkWieczorek opened this issue Dec 18, 2020 · 1 comment
Closed
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Milestone

Comments

@MarkWieczorek
Copy link
Contributor

In practice, whenever an image is plotted using shading ("grdimage -I...") it is common to use the "-I" option for the colorbar as well. At present there is no documentation of the colorbar "-I" option, but it turns out that you can get this to work anyways. Two calling options are

fig.colorbar(I='')

or

fig.colorbar(I=True)

For simplicity, I would probably document the second option.

Furthermore, for consistency with grdimage the colobar function should have an alias called shading so that we don't have to use the cryptic gmt short commands.

@seisman seisman added documentation Improvements or additions to documentation help wanted Helping hands are appreciated labels Dec 18, 2020
@seisman
Copy link
Member

seisman commented Dec 22, 2020

Closed by #752.

@seisman seisman closed this as completed Dec 22, 2020
@seisman seisman added this to the 0.3.0 milestone Dec 22, 2020
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 help wanted Helping hands are appreciated
Projects
None yet
Development

No branches or pull requests

2 participants