-
Notifications
You must be signed in to change notification settings - Fork 214
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
Figure.grdcontour: improve the documentation of the pen parameter #2704
Comments
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our contributing guidelines and code of conduct. |
Thanks @HouseJaay for pointing out this limitation of the docstrings 🙂! Actually this is not only relevant for For these two methods, I feel we should not only update the allowed input types for the
If you'd like to work on these updates, feel free to submit a pull request. For details on how contributing to PyGMT works, you may want to take a look at our Contributors Guide. Please ask any questions you have. |
What is the status on this issue? Would it be fine if I submit a PR for improving the docstring for the |
Yes, please improve the docstrings following the GMT docs. |
Submitted PR #3210 for this. |
Please describe what could be improved about this page or the typo/mistake that you found:
"pen (str) – Set pen attributes for lines or the outline of symbols."
should be:
"pen (str, list) – Set pen attributes for lines or the outline of symbols."
Because we can set pen attributes for contour lines with and without annotations separately.
Example: pen=['a0.75p,white', 'c0.25p,white'].
The text was updated successfully, but these errors were encountered: