Add return statement to grdclip and grdgradient docstring

[kadatatlukishore]

Description of proposed changes

Updated the docstring in grdclip.py to have a return statement.

Fixes #1388

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 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

[welcome]

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

• If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
• All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
• No matter what, we are really grateful that you put in the effort to do this! 🎉

[kadatatlukishore]

Hey @meghanrjones , I have just added the docstring please review. Thanks.

[maxrjones]

Thanks for your pull request, @kadatatlukishore! Nice work! I have made two small suggestions that add one blank line. The first is for separation from the other section of the docstring and the second is required for the list to be rendered properly in sphinx. You can check out the Vercel preview if you want to see the built docs.

[kadatatlukishore]

Hello @meghanrjones , made the required changes. Preview look fine. Thanks for the suggestions !

[maxrjones]

Looks great!

I'll leave this PR open for up to a day before merging, just in case any of the other maintainers have comments. Thanks again for your contribution!

[maxrjones]

/format

[weiji14]

Seems like grdgradient could also use the same treatment 🙂 @kadatatlukishore, if you have time, do you mind copy-and-pasting the same chunk of documentation to

pygmt/pygmt/src/grdgradient.py

Line 94 in 9b60f5c

{n}

Thanks!

[maxrjones]

Seems like grdgradient could also use the same treatment 🙂 @kadatatlukishore, if you have time, do you mind copy-and-pasting the same chunk of documentation to

pygmt/pygmt/src/grdgradient.py

Line 94 in 9b60f5c

{n}

Thanks!

@weiji14 do you want this change in the same or a separate pull request?

[weiji14]

Seems like grdgradient could also use the same treatment slightly_smiling_face @kadatatlukishore, if you have time, do you mind copy-and-pasting the same chunk of documentation to

pygmt/pygmt/src/grdgradient.py

Line 94 in 9b60f5c

{n}

Thanks!

@weiji14 do you want this change in the same or a separate pull request?

I think it's ok to have it in the same pull request since it is a related change and not too big. But ok with making it into a separate thing if it's a bit troublesome.

[kadatatlukishore]

Seems like grdgradient could also use the same treatment slightly_smiling_face @kadatatlukishore, if you have time, do you mind copy-and-pasting the same chunk of documentation to

pygmt/pygmt/src/grdgradient.py

Line 94 in 9b60f5c

{n}

Thanks!

@weiji14 do you want this change in the same or a separate pull request?

I think it's ok to have it in the same pull request since it is a related change and not too big. But ok with making it into a separate thing if it's a bit troublesome.

I can work on the same pull request. Thanks @weiji14

[maxrjones]

/format

[kadatatlukishore]

Hello @meghanrjones , Should I have to make any changes ?

[seisman]

Have to manually remove these whitespaces in blank lines.

[welcome]

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

[maxrjones]

Great work @kadatatlukishore and thanks again for addressing this issue! 🎉