-
Notifications
You must be signed in to change notification settings - Fork 217
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
Remote datasets: Include images of the official documentation in API reference #2728
Conversation
Some questions:
|
I prefer to put the images at the top, just below the "Load xxx dataset in various resolutions" sentence, because the images are more eye-catching than the long description. I also prefer to make the images slightly smaller. I usually use a relative width like
They look quite different in some places. A side-by-side table sounds a good idea.
I think the colormap really doesn't matter much for earth_mask. |
That's fine with me and is done in commit fdfa599.
Using a relative width is also fine with me.
A table containing the images for the magnetic datasets is added in commits 111b0c1, 9fb1f13, and 8399c28.
Yeah, I was also wondering about the annotated frame and think this image should be consistent with the images for the other datasets. |
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
The following warning is from pylint:
and the following warning is from pycodestyle:
It seems we have two tools that check line length. Maybe we should disable one? BTW, the following code can disable both warnings but itself is too long:
|
If we us a tool setting a limit of |
I opened an issue regarding removing the annotated fancy frame at GenericMappingTools/remote-datasets#83. |
Done in PR #2735. |
PR #2735 has been merged, now it's possible to write like:
|
…re::' Co-authored-by: Dongdong Tian <[email protected]>
@yvonnefroehlich See GenericMappingTools/remote-datasets#89 for the upstream changes of image names. |
Description of proposed changes
This PR aims to include images of the remote datasets in the API reference by adding the links to the images showen at https://www.generic-mapping-tools.org/remote-datasets/.
Fixes #2325
Preview:
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 commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version