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

Docs updates: add FileStore and misc edits #668

Merged
merged 3 commits into from
May 27, 2022

Conversation

rkingsbury
Copy link
Collaborator

@rkingsbury rkingsbury commented May 27, 2022

Documentation updates for maggma. The primary purpose of this PR is to add thorough documntation of the recently-merged FileStore (see #619 ).

I also took the opportunity to make some edits, including:

  • Correcting inaccurate language about python 3.6 support which was dropped
  • Re-ordering some documentation sections based on what I think a newcomer most needs to know
  • Wordsmithing and typos

I have inspected the changes using mkdocs serve and all seems to compile cleanly, but let me know if you spot any issues!

@codecov
Copy link

codecov bot commented May 27, 2022

Codecov Report

Merging #668 (a1b5222) into main (e84dc1d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #668   +/-   ##
=======================================
  Coverage   89.43%   89.43%           
=======================================
  Files          42       42           
  Lines        3048     3048           
=======================================
  Hits         2726     2726           
  Misses        322      322           
Impacted Files Coverage Δ
src/maggma/stores/file_store.py 98.02% <ø> (ø)

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 d63e076...a1b5222. Read the comment docs.

@munrojm
Copy link
Member

munrojm commented May 27, 2022

The new documentation looks fantastic @rkingsbury! Really appreciate the effort in both adding to and cleaning up what was there. I will go ahead and merge these changes.

@munrojm munrojm merged commit b506eb8 into materialsproject:main May 27, 2022
@rkingsbury rkingsbury deleted the filestore branch May 27, 2022 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants