Skip to content

document classes and overrides used in the example app #487

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

Closed
2 of 3 tasks
n2ygk opened this issue Oct 6, 2018 · 0 comments · Fixed by #979
Closed
2 of 3 tasks

document classes and overrides used in the example app #487

n2ygk opened this issue Oct 6, 2018 · 0 comments · Fixed by #979

Comments

@n2ygk
Copy link
Contributor

n2ygk commented Oct 6, 2018

Usage documentation and the example app are not consistent with each other. There are several classes used in the example that lack proper usage documentation and docstrings.

Documentation updates (or changes to use documented classes and deprecation of undocumented classes) are needed for the following:

  • relations.SerializerMethodResourceRelatedField
  • relations.SerializerMethodHyperlinkedRelatedField
  • get_queryset() and get_object() implementation differs between example views and usage doc.

There may be others; please update this list if you see them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant