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.

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

Use consistent docstrings for test files #2578

Merged
merged 4 commits into from Jun 17, 2023
Merged

Use consistent docstrings for test files #2578

merged 4 commits into from Jun 17, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Jun 15, 2023

Description of proposed changes

Closes #2571.

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 the maintenance Boring but important stuff for the core devs label Jun 15, 2023
@seisman seisman added this to the 0.10.0 milestone Jun 15, 2023
@seisman seisman added the needs review This PR has higher priority and needs review. label Jun 15, 2023
pygmt/tests/test_blockm.py Outdated Show resolved Hide resolved
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

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

I am wondering whether we also should update these docstrings:

$ grep "Tests" *
grep: baseline: Is a directory
grep: data: Is a directory
test_clib_loading.py:# Tests for load_libgmt
test_clib_loading.py:# Tests for clib_full_names
test_helpers.py:Tests the helper functions/classes/etc used in wrapping GMT.
test_io.py:Tests for input/output (I/O) utilities.

seisman and others added 3 commits June 16, 2023 08:04
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Copy link
Member Author

seisman commented Jun 16, 2023

I am wondering whether we also should update these docstrings:

$ grep "Tests" *
grep: baseline: Is a directory
grep: data: Is a directory
test_clib_loading.py:# Tests for load_libgmt
test_clib_loading.py:# Tests for clib_full_names
test_helpers.py:Tests the helper functions/classes/etc used in wrapping GMT.
test_io.py:Tests for input/output (I/O) utilities.

Done in 09fb8bf.

@yvonnefroehlich yvonnefroehlich 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 Jun 16, 2023
@seisman seisman merged commit 231c79f into main Jun 17, 2023
13 checks passed
@seisman seisman deleted the test-docstrings branch June 17, 2023 00:47
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 17, 2023
weiji14 added a commit that referenced this pull request Jul 20, 2023
Xref #2571 and #2578

Co-Authored-By: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent docstrings for test_*.py files
4 participants