Numpy docstyle for core submodule #339
Merged
Conversation
This file contains 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
bdice
requested review from
tcmoore3 and
Charlottez112
and removed request for
a team
Codecov Report
@@ Coverage Diff @@
## numpy_docs #339 +/- ##
===========================================
Coverage 76.22% 76.22%
===========================================
Files 43 43
Lines 7086 7088 +2
===========================================
+ Hits 5401 5403 +2
Misses 1685 1685
Continue to review full report at Codecov.
|
Charlottez112
approved these changes
Jun 15, 2020
tcmoore3
approved these changes
Jun 17, 2020
| @@ -28,6 +29,7 @@ def __init__(self, prefix): | |||
|
|
|||
| @property | |||
| def prefix(self): | |||
| """Return the prefix.""" | |||
mikemhenry
pushed a commit
that referenced
this pull request
Jul 22, 2020
* numpydoc style(signac/contrib/schema.py) (#318) * numpydoc style(signac/contrib/project.py) (#320) * numpydoc style(signac/contrib/job.py) (#319) * numpydoc style(signac/contrib/linked_view.py, signac/contrib/utility.py, signac/core/utility.py) (#326) * numpydoc style(signac/contrib/errors.py, signac/contrib/filesystems.py, signac/contrib/filterparser.py, signac/contrib/hashing.py) (#322) * numpydoc style (signac/contrib/collection.py) (#329) * Make core submodule adhere to numpydoc conventions. (#339) * add a docstring for public module (#337) * numpydoc style (signac/contrib/import_export.py) (#333) * Apply NumPy docstyle to remaining files in "signac" root. (#343) * Apply fixes from minirst. (#356) * Enforce pydocstyle in core, common, contrib. (#354) Co-authored-by: Bradley Dice <[email protected]> Co-authored-by: Alyssa Travitz <[email protected]> Co-authored-by: Abhavya Chandra <[email protected]> Co-authored-by: vyasr <[email protected]> Co-authored-by: Pengji <[email protected]> Co-authored-by: Mike Henry <[email protected]>
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
Applied numpy docstyle to the core submodule.
Motivation and Context
Part of #315.
Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist:
If necessary: