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

update(docs): document apis #56

Merged
merged 1 commit into from
Oct 2, 2020
Merged

update(docs): document apis #56

merged 1 commit into from
Oct 2, 2020

Conversation

sumit4613
Copy link
Member

@sumit4613 sumit4613 commented Oct 2, 2020

Hey, I just made a Pull Request!

Description

This PR documents APIs and closes #47

Motivation and Context

Have you tested this? If so, how?

Checklist for PR author(s)

  • Changes are covered by unit tests (no major decrease in code coverage %).
  • All tests pass.
  • Docstring coverage is 100% via interrogate drf_user (I mean, we should set a good example 😄).
  • Updates to documentation:
    • Document any relevant additions/changes in README.md.
    • Manually update both the README.md and docs/index.rst for any new changes.
    • Any changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives. Find the appropriate next version in the project's __init__.py file.

Release note


@codecov
Copy link

codecov bot commented Oct 2, 2020

Codecov Report

Merging #56 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #56   +/-   ##
=======================================
  Coverage   91.22%   91.22%           
=======================================
  Files          17       17           
  Lines         638      638           
=======================================
  Hits          582      582           
  Misses         56       56           
Flag Coverage Δ
#unittests 91.22% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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 68394ed...ac77faa. Read the comment docs.

@sumit4613 sumit4613 merged commit 807cb56 into master Oct 2, 2020
@sumit4613 sumit4613 deleted the sumit/document-apis branch October 2, 2020 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document APIs in documentation
1 participant