Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

numpydoc style (signac/contrib/import_export.py) #333

Merged
merged 6 commits into from
Jun 30, 2020

Conversation

ac-optimus
Copy link
Contributor

Description

issue #315

Motivation and Context

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

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

Checklist:

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 import_export.py

@codecov
Copy link

codecov bot commented May 1, 2020

Codecov Report

Merging #333 into numpy_docs will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff               @@
##           numpy_docs     #333      +/-   ##
==============================================
- Coverage       76.23%   76.20%   -0.04%     
==============================================
  Files              43       43              
  Lines            7089     7080       -9     
==============================================
- Hits             5404     5395       -9     
  Misses           1685     1685              
Impacted Files Coverage Δ
signac/contrib/import_export.py 84.75% <ø> (ø)
signac/common/errors.py 75.00% <0.00%> (-1.93%) ⬇️
signac/core/utility.py 71.42% <0.00%> (-0.80%) ⬇️
signac/core/json.py 83.33% <0.00%> (-0.67%) ⬇️
signac/contrib/filterparse.py 83.87% <0.00%> (-0.26%) ⬇️
signac/contrib/utility.py 58.68% <0.00%> (-0.25%) ⬇️
signac/core/attrdict.py 96.00% <0.00%> (-0.16%) ⬇️
signac/contrib/linked_view.py 87.16% <0.00%> (-0.09%) ⬇️
signac/contrib/collection.py 89.06% <0.00%> (-0.03%) ⬇️
signac/warnings.py 100.00% <0.00%> (ø)
... and 5 more

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 be44cae...f209493. Read the comment docs.

@mikemhenry mikemhenry added the doc-style Update docs to numpy doc style label May 5, 2020
@bdice bdice added this to the v1.5.0 milestone May 7, 2020
@mikemhenry
Copy link
Collaborator

Just giving this a PR a bump, @ac-optimus let me know if you have any questions or if there are any blockers.

@bdice
Copy link
Member

bdice commented Jun 25, 2020

@ac-optimus Let us know if you'd like someone else to finish up this PR or if you'd like to finish it (it's still marked as a draft). Thanks! 👍

@ac-optimus
Copy link
Contributor Author

@ac-optimus Let us know if you'd like someone else to finish up this PR or if you'd like to finish it (it's still marked as a draft). Thanks!

hi, sure I would be happy if someone else could take this up.

@bdice bdice assigned bdice and unassigned ac-optimus Jun 28, 2020
@bdice bdice marked this pull request as ready for review June 28, 2020 14:55
@bdice bdice requested review from a team as code owners June 28, 2020 14:55
@bdice bdice requested review from csadorf and vishav1771 and removed request for a team June 28, 2020 14:55
@bdice
Copy link
Member

bdice commented Jun 28, 2020

@ac-optimus Thanks for your help. I finished up this PR. @csadorf and @vishav1771, please review when convenient. 👍

signac/contrib/import_export.py Outdated Show resolved Hide resolved
signac/contrib/import_export.py Outdated Show resolved Hide resolved
signac/contrib/import_export.py Outdated Show resolved Hide resolved
Co-authored-by: Carl Simon Adorf <[email protected]>
Copy link
Contributor

@vishav1771 vishav1771 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@vyasr vyasr merged commit e820947 into glotzerlab:numpy_docs Jun 30, 2020
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
Labels
doc-style Update docs to numpy doc style
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants