-
Notifications
You must be signed in to change notification settings - Fork 96
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
Missing documentation for examples #11
Comments
@armaniferrante I've attempted this here Please have a look at the above example commit, if that seems fine. May be I can pick it up from there on and document other cases too. |
Or maybe we can add a README.md in every example about the recommended practice (theory). The motivation is to get reader a clear idea about what is that we are trying to achieve and what approach we are taking |
Man, this would be absolutely awesome |
@armaniferrante we should add one/two liner comments or doc comments on every example
explaining
unsafe - why it's unsafe
recommended - why this practice is recommended
secure - why it's secure.
It'll definitely help new repo visitor understand the moto behind the different approaches and will help get deeper understanding overall.
The text was updated successfully, but these errors were encountered: