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

Add docs section about mixins #34

Open
swistakm opened this issue Nov 15, 2016 · 0 comments
Open

Add docs section about mixins #34

swistakm opened this issue Nov 15, 2016 · 0 comments

Comments

@swistakm
Copy link
Owner

Usage of mixin classes may be a bit confusing. Extend the guide/resources.rst to provide introduction to mixins and how to use them with BaseResource class.

Additional tasks related with this issue:

  • If initial support of optional contexts (refs #32) #33 gets merged, add some brief information about context-aware classes and point to proper document for more detailed description on this topic.
  • Decide on how to properly call all the retrieve/update/list/etc. methods and do cleanup in the docs to unify this terminology
  • Put a small glossary for the users and doc writers somewhere
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant