Conversation
weiji14
reviewed
Dec 4, 2021
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Member
|
I feel the current structure is very confusing. Users may think it's |
Member
Author
Yes, I agree. I tried to add more clarity in the latest commit by reordering the sections so all Figure methods are first and adding a note to the functions not provided through the Figure class. I also added subsection headers so that the toctree has a bit more structure. Let me know whether you think this is more clear. |
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
michaelgrund
approved these changes
Dec 17, 2021
Member
michaelgrund
left a comment
There was a problem hiding this comment.
Great work @meghanrjones. The structure is now much more clear and it's easier to find functions related to a specific topic.
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This PR splits the pygmt.Figure methods into more sections in the API documentation.
Fixes #1633
Reminders
make formatandmake checkto 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