numpydoc style(signac/contrib/schema.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 #318 into numpy_docs will increase coverage by 0.01%.
The diff coverage is 87.50%.

@@              Coverage Diff               @@
##           numpy_docs     #318      +/-   ##
==============================================
+ Coverage       76.18%   76.19%   +0.01%     
==============================================
  Files              43       43              
  Lines            7076     7079       +3     
==============================================
+ Hits             5391     5394       +3     
  Misses           1685     1685              

Impacted Files	Coverage Δ
signac/contrib/project.py	91.58% <50.00%> (ø)
signac/contrib/import_export.py	84.75% <100.00%> (ø)
signac/contrib/schema.py	97.65% <100.00%> (+0.05%)	⬆️

---

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 deb56fa...be9530b. Read the comment docs.

[bdice]

I suggested some docstrings. This will need a few more iterations to be complete.

[ac-optimus]

@bdice @Tobias-Dwyer i have added all of the docstrings i can. Can you please help with the rest!

[bdice]

Here are some more suggested docstrings. There are still some missing.

[bdice]

@ac-optimus When you are able, please review the comments so far. Please click "Resolve conversation" on all the changes you have applied and only leave the comments that you aren't sure about. Try to fill some of the remaining docstrings, to the best of your ability. Then re-request my review and I can take another pass on anything that's left.

[ac-optimus]

@ac-optimus When you are able, please review the comments so far. Please click "Resolve conversation" on all the changes you have applied and only leave the comments that you aren't sure about. Try to fill some of the remaining docstrings, to the best of your ability. Then re-request my review and I can take another pass on anything that's left.

@bdice done that.

[bdice]

Looks good to me!

[Tobias-Dwyer]

looks good to me!