Improve docstring of data_kind() to include xarray grid#588
Merged
Conversation
84a0f6a to
91858e1
Compare
weiji14
approved these changes
Sep 6, 2020
Member
weiji14
left a comment
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Improve the docstrings of
data_kind()and add one more doctest.Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.