Skip to content

Conversation

@onel
Copy link

@onel onel commented Jul 28, 2025

This is a first round of adding minimal reference docs.
Working on a more comprehensive addition right now.

Issue: #337

@jonashaag
Copy link
Owner

@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.

@onel
Copy link
Author

onel commented Jul 29, 2025

@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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants