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

Enable enhanced documentation #468

Merged

Conversation

munrojm
Copy link
Member

@munrojm munrojm commented Aug 4, 2021

This PR includes:

  • API and tag descriptions can now be passed to API for FastAPI generated documentation
  • GetByKey now has a more detailed description
  • Model fields to project now explicitly listed in sparse fields query op

@codecov
Copy link

codecov bot commented Aug 4, 2021

Codecov Report

Merging #468 (c4d0932) into main (7eca4d5) will decrease coverage by 0.18%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #468      +/-   ##
==========================================
- Coverage   88.44%   88.26%   -0.19%     
==========================================
  Files          40       40              
  Lines        2631     2633       +2     
==========================================
- Hits         2327     2324       -3     
- Misses        304      309       +5     
Impacted Files Coverage Δ
src/maggma/api/query_operator/sparse_fields.py 97.05% <ø> (ø)
src/maggma/api/resource/read_resource.py 98.64% <ø> (ø)
src/maggma/api/API.py 81.39% <100.00%> (+0.90%) ⬆️
src/maggma/stores/mongolike.py 82.19% <0.00%> (-1.90%) ⬇️
src/maggma/core/drone.py 92.42% <0.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 7eca4d5...c4d0932. Read the comment docs.

@munrojm munrojm merged commit 5c8c620 into materialsproject:main Aug 4, 2021
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.

None yet

1 participant