Skip to content

Improve docstring of data_kind() to include xarray grid#588

Merged
seisman merged 3 commits intomasterfrom
doc/data_kind
Sep 7, 2020
Merged

Improve docstring of data_kind() to include xarray grid#588
seisman merged 3 commits intomasterfrom
doc/data_kind

Conversation

@seisman
Copy link
Member

@seisman seisman commented Sep 6, 2020

Description of proposed changes

Improve the docstrings of data_kind() and add one more doctest.

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.

@vercel vercel bot temporarily deployed to Preview September 6, 2020 23:16 Inactive
@vercel vercel bot temporarily deployed to Preview September 6, 2020 23:17 Inactive
@seisman seisman added this to the 0.2.x milestone Sep 6, 2020
@seisman seisman added the documentation Improvements or additions to documentation label Sep 6, 2020
@vercel vercel bot temporarily deployed to Preview September 6, 2020 23:18 Inactive
@seisman seisman requested a review from weiji14 September 6, 2020 23:23
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

This is good. Just one suggestion to change the title to something like: "Improve docstring of data_kind() to include xarray grid".

Also, this reminds me that I'll need to do the same for the 'buffer' data_kind docstring at #576.

@seisman seisman changed the title Improve docstrings of data_kind() Improve docstring of data_kind() to include xarray grid Sep 6, 2020
@seisman seisman merged commit 4856d64 into master Sep 7, 2020
@seisman seisman deleted the doc/data_kind branch September 7, 2020 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants