-
Notifications
You must be signed in to change notification settings - Fork 299
Document goals of Django REST Framework JSON API #447
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
Conversation
Codecov Report
Merging #447 into master will not change coverage.
The diff coverage isn/a.
@@ Coverage Diff @@ ## master #447 +/- ## ====================================== Coverage 93.1% 93.1% ====================================== Files 54 54 Lines 3000 3000 ====================================== Hits 2793 2793 Misses 207 207
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 cb7f830...f7f8383. Read the comment docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 I think adding some goals explicitly to the docs is a great idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line looks good in the plain text, but I think it won't format well in the final documentation. It would look like "... as possible e.g. issues in Django...." I think the line should be wrapped with parentheses.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
Add goals of Django RESTFramework JSON API which we can reference to and use as basis in discussions of issues and pull requests.
This goals are extracted from following comment made by @mblayman. I can fully agree to those points and think it is important to document those goals in a easy to find place.
Checklist
CHANGELOG.mdAUTHORS