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

docs: Use consistent description for the 'outgrid' parameter #2874

Merged
merged 3 commits into from
Dec 14, 2023
Merged

docs: Use consistent description for the 'outgrid' parameter #2874

merged 3 commits into from
Dec 14, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 13, 2023 •
edited
Loading

Description of proposed changes

Preview: https://pygmt-dev--2874.org.readthedocs.build/en/2874/api/generated/pygmt.grdclip.html#pygmt.grdclip

Fixes #2695

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.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@seisman seisman added documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. labels Dec 13, 2023
@seisman seisman added this to the 0.11.0 milestone Dec 13, 2023
@michaelgrund michaelgrund added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 14, 2023
@yvonnefroehlich
Copy link
Member

yvonnefroehlich commented Dec 14, 2023 •
edited
Loading

This is not directly related to this PR, but I am wondering why there is sometimes a blank line between the docstrings of two parameters and sometimes not (the example is from grdclip):

pygmt/pygmt/src/grdclip.py

Lines 51 to 56 in ec22b0c

Parameters
----------
{grid}
{outgrid}
{region}
above : str or list

Results in:
blank_lines_in_docs_built

@seisman seisman merged commit 7d6f615 into main Dec 14, 2023
16 of 17 checks passed
@seisman seisman deleted the docs/outgrid branch December 14, 2023 22:29
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michaelgrund michaelgrund michaelgrund approved these changes

@yvonnefroehlich yvonnefroehlich yvonnefroehlich approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.11.0
Development

Successfully merging this pull request may close these issues.

Use complete and consistent descriptions for grid and outgrid
3 participants
@seisman @yvonnefroehlich @michaelgrund