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

Documentation - Model Annotation / Traits #1107

Closed
notryanb opened this Issue Aug 15, 2017 · 2 comments

Comments

2 participants
@notryanb
Contributor

notryanb commented Aug 15, 2017

Problem Description

Re: Better Documentation #853 Models

Documentation on model annotations (Queryable, Identifiable, Insertable, etc...) and the code they generate is sparse and spread out over the API documentation. Available guides (Getting Started & All About Updates) make mention of the derivable traits, but do not go into much depth.

What are you trying to accomplish?

  • Create a central location to reference all the traits that can derived
  • Explain why these derives are useful or important
  • Explain how to implement the traits without the struct annotations (for comparison or writing custom ones)
  • Provide specific example use cases (and even erroneous cases?).

Checklist

  • I have already looked over the issue tracker for similar issues.
@notryanb

This comment has been minimized.

Contributor

notryanb commented Sep 18, 2017

Now that df5a6e8 has been merged, I believe this can now be closed.

@killercup

This comment has been minimized.

Member

killercup commented Sep 18, 2017

Indeed! Thanks again for that awesome PR!

@killercup killercup closed this Sep 18, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment