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

Enhance documentation #354

Merged
merged 7 commits into from
Aug 4, 2021
Merged

Enhance documentation #354

merged 7 commits into from
Aug 4, 2021

Conversation

munrojm
Copy link
Member

@munrojm munrojm commented Aug 3, 2021

This PR greatly enhances the documentation for the API seen on the auto-generated Swagger and Redoc documentation pages:

  • Overall description
  • Enhanced tag descriptions with outside doc links
  • Enhanced GetByKey descriptions with fields

@codecov-commenter
Copy link

Codecov Report

Merging #354 (8e86347) into main (8db87c4) will decrease coverage by 0.04%.
The diff coverage is 60.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #354      +/-   ##
==========================================
- Coverage   93.17%   93.12%   -0.05%     
==========================================
  Files          60       61       +1     
  Lines        1950     1965      +15     
==========================================
+ Hits         1817     1830      +13     
- Misses        133      135       +2     
Impacted Files Coverage Δ
src/mp_api/core/documentation.py 0.00% <0.00%> (ø)
src/mp_api/core/api.py 100.00% <100.00%> (ø)
src/mp_api/core/settings.py 100.00% <100.00%> (ø)
src/mp_api/matproj.py 98.52% <0.00%> (+0.14%) ⬆️

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 8db87c4...8e86347. Read the comment docs.

@munrojm munrojm added the release:minor Minor release bump label Aug 4, 2021
@munrojm munrojm merged commit 76b60cf into main Aug 4, 2021
@munrojm munrojm deleted the enhance_documentation branch August 4, 2021 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:minor Minor release bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants