Added more reference docs by onel · Pull Request #338 · jonashaag/klaus

onel · 2025-07-28T23:48:55Z

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

Issue: #337

for more information, see https://pre-commit.ci

jonashaag · 2025-07-29T13:11:53Z

@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 · 2025-07-29T13:13:58Z

@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

for more information, see https://pre-commit.ci

…ence-docs

onel and others added 9 commits July 29, 2025 02:32

Added reference documentation for: klaus/contrib/wsgi.py

4dbce3f

Added reference documentation for: klaus/ctagsutils.py

4315f45

Added reference documentation for: tools/dumbtest.py

2f33093

Added reference documentation for: setup.py

4be6f8a

Added reference documentation for: klaus/contrib/wsgi_autoreload.py

276517f

Added reference documentation for: klaus/contrib/app_args.py

e302bbe

Reverted setup.py

4b79dc1

Reverted setup.py

765460e

[pre-commit.ci] auto fixes from pre-commit.com hooks

f864061

for more information, see https://pre-commit.ci

jelmer reviewed Jul 29, 2025

View reviewed changes

Comment thread setup.py Outdated

Comment thread klaus/ctagsutils.py Outdated