-
Notifications
You must be signed in to change notification settings - Fork 216
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.plot: Update docstring for "connection" parameter to GMT 6.5 #2994
Conversation
This reverts commit 686b4a7.
I also found the same issue in PR #2992. There are three files that use external resources and removing all of them fixes the ReadTheDocs failure (see 70d53af). |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to merge after add the two examples back.
/format |
Description of proposed changes
Over time, the general syntax for the
connection
(F) parameter ofFigure.plot
has changed:GMT 6.2
-F[c|n|r][a|f|s|r|refpoint]
GMT 6.3
-F[c|n|p][a|f|s|r|refpoint]
GMT 6.5
-F[c|n|p][a|r|s|t|refpoint]
This PR updates the related docstring in the PyGMT documentation to match the GMT 6.5 documentation. I feel this makes sense, as we link to the last GMT version and we use it in the gallery examples, or?
I am wondering whether the last line of the figure caption in the GMT documentation has to be updated from
"
directives ra, rt, rs, r10/35 and na
" to"
directives pa, pt, ps, p10/35 and na
"?Preview:
There is currently an issue with buiding the documentation:
Edit 2024/13/01
Excluding the gallery example
chorophleth_map.py
(see commit) leads toSo, the issue seem to be unrelated to the
chorophleth_map.py
example (downloading the data).After removing both
chorophleth_map.py
androads.py
building the documentation is successful.https://pygmt-dev--2994.org.readthedocs.build/en/2994/api/generated/pygmt.Figure.plot.html
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