klaus icon indicating copy to clipboard operation
klaus copied to clipboard
verified publisher icon jonashaag

Added more reference docs

Open onel opened this issue 4 months ago • 2 comments

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

Issue: #337

onel avatar Jul 28 '25 23:07 onel

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

jonashaag avatar Jul 29 '25 13:07 jonashaag

@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

onel avatar Jul 29 '25 13:07 onel