-
Notifications
You must be signed in to change notification settings - Fork 103
Added more reference docs #338
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
base: master
Are you sure you want to change the base?
Conversation
for more information, see https://pre-commit.ci
|
@onel thanks for taking a stab at this! Good comments should focus on the "why", not the "what" or the "how". The latter are already described by the code, and if you duplicate that information as comments, it gets out of sync with the implementation really quickly. |
Those are good points. Going through your comments and will update the PR soon |
This is a first round of adding minimal reference docs.
Working on a more comprehensive addition right now.
Issue: #337