-
Notifications
You must be signed in to change notification settings - Fork 230
Figure.makecpt: Improve the docstring of the 'reverse' parameter #3009
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
Conversation
I feel it's a good time to make the The long argument names |
Sounds fair! Should this be done in this PR or in a separate follow-up PR? |
Better to do it in this PR, since the docstring needs rewritten for the Pythonic |
I prefer to have this PR merged first, and will revisit the issue above later, when we have time focusing on improving the |
Description of proposed changes
I feel it is fair to mention in the docstring that using the
reverse
parameter ofFigure.makecpt
also exchanges the background (B) and foreground (F) colors.Upstream GMT documentation: https://docs.generic-mapping-tools.org/6.5/makecpt.html#i
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code