Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add link to GMT full option list for grdproject, grdsample and project #1716

Merged
merged 4 commits into from
Mar 19, 2022
Merged

Add link to GMT full option list for grdproject, grdsample and project #1716

merged 4 commits into from
Mar 19, 2022

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Jan 31, 2022 •
edited by seisman
Loading

Description of proposed changes

Adds missing link to GMT doc page for grdproject, grdsample and project. Also standardize to use 'Full option list' across all modules (some were using 'Full parameter list' before).

Patches #1377, #1380, #1122.

Closes #1621.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@weiji14 weiji14 added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Jan 31, 2022
@weiji14 weiji14 added this to the 0.6.0 milestone Jan 31, 2022
@weiji14 weiji14 self-assigned this Jan 31, 2022
@maxrjones
Copy link
Member

I think all options for grdimage and grdproject have aliases in PyGMT. For these and others with completed aliases, I think Based on <module-link> would make more sense than Full option list at <module-link>.

@weiji14
Copy link
Member Author

weiji14 commented Jan 31, 2022

I think all options for grdimage and grdproject have aliases in PyGMT. For these and others with completed aliases, I think Based on <module-link> would make more sense than Full option list at <module-link>.

Fair point. What do others think about having fully aliased PyGMT modules use 'Based on <module-link>'?

That said, this change is only worth it if we can make sure Paul doesn't add new options to those modules in the future 😆

@seisman
Copy link
Member

seisman commented Mar 1, 2022

I think all options for grdimage and grdproject have aliases in PyGMT. For these and others with completed aliases, I think Based on <module-link> would make more sense than Full option list at <module-link>.

Sounds good to me.

@weiji14 weiji14 modified the milestones: 0.6.0, 0.6.1 Mar 11, 2022
maxrjones
maxrjones approved these changes Mar 15, 2022
View reviewed changes
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current wording is fine with me.

@seisman seisman marked this pull request as ready for review March 18, 2022 04:26
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Mar 18, 2022
@seisman seisman merged commit e03035b into main Mar 19, 2022
@seisman seisman deleted the doc/full-option-list branch March 19, 2022 02:05
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 19, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@weiji14
Add link to GMT full option list for grdproject, grdsample and project (
dde99e8 
GenericMappingTools#1716)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@seisman seisman seisman approved these changes

@maxrjones maxrjones maxrjones approved these changes

Assignees

@weiji14 weiji14

Labels
documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Milestone
0.6.1
Development

Successfully merging this pull request may close these issues.

Missing links to upstream GMT documentation
3 participants
@weiji14 @maxrjones @seisman