numpydoc style(signac/contrib/errors.py, signac/contrib/filesystems.py, signac/contrib/filterparser.py, signac/contrib/hashing.py)

[ac-optimus]

Description

issue #315

Motivation and Context

Types of Changes

• Documentation update
• Bug fix
• New feature
• Breaking change¹

¹The change breaks (or has the potential to break) existing functionality.

Checklist:

• I am familiar with the Contributing Guidelines.
• I agree with the terms of the Contributor Agreement.
• My name is on the list of contributors.
• My code follows the code style guideline of this project.
• The changes introduced by this pull request are covered by existing or newly introduced tests.

If necessary:

• I have updated the API documentation as part of the package doc-strings.
• I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
• I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable). See example below.

Change of doc string to numpydoc in schema.py

[codecov]

Codecov Report

Merging #322 into numpy_docs will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           numpy_docs     #322   +/-   ##
===========================================
  Coverage       76.20%   76.20%           
===========================================
  Files              43       43           
  Lines            7080     7082    +2     
===========================================
+ Hits             5395     5397    +2     
  Misses           1685     1685           

Impacted Files	Coverage Δ
signac/common/errors.py	76.92% <100.00%> (+1.92%)	⬆️
signac/contrib/errors.py	94.11% <100.00%> (-0.62%)	⬇️
signac/contrib/filterparse.py	84.12% <100.00%> (+0.25%)	⬆️
signac/contrib/hashing.py	100.00% <100.00%> (ø)
signac/core/errors.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed69d02...ba92ecb. Read the comment docs.

[bdice]

@ac-optimus Here are some initial suggestions. This will need further iterations. Please read over the NumPy docstring style guide carefully. I haven't had a chance to read it in full, but it will probably answer some of my questions in this review. Also, it will help us be consistent if we adhere to those rules. https://numpydoc.readthedocs.io/en/latest/format.html

[bdice]

@ac-optimus I edited the setup.cfg file and a few of the files that this PR is meant to update. Take a look at those edits, since we'll need to make similar changes in the other docstyle pull requests. The changes in setup.cfg will probably conflict for all of these pull requests, and will need to be resolved as the PRs are merged into the numpy_docs branch.

I left filesystems.py off of the list of pydocstyle files in setup.cfg, since we shouldn't bother updating docs for all the deprecated features that we plan to remove soon.

[bdice]

@ac-optimus I had a typo in the name of filterparse.py. I pushed that change to setup.cfg but the docstrings in that file need to be updated. You can see the errors by installing and running pydocstyle in the repository root.

[ac-optimus]

@bdice I have made the changes. Thank you for pointing me to pydocstyle.
Will modify setup.cfg accordingly in other PRs as well.

[tcmoore3]

LGTM

[yuanzhou0827]

All changes look good to me except the added period mentioned by Tim.

[bdice]

I am going to apply my own change requests and merge this PR.

[bdice]

Unfortunately that example is for a slightly different case. That would apply if _cast returned two values. This function doesn't have a defined return type, so it should claim its return type is object. I will make a suggestion above.