4 ms·
That's a lot of context for not much content. I ussually start with something like: - Prefer documentation as code - Comment why, not what - Document public
by jurf 1mo ago
That's a lot of context for not much content. I ussually start with something like:
- Prefer documentation as code
- Comment why, not what
- Document public APIs
- Readability is paramount
That usually gets me 80% there; rest is covered by the linter.
I'm mostly just missing it explaining previous state too much, especially when making edits to plans, but I have not found good wording for that yet.
- nikitau 1mo agoI'm also doing something similar, as for over-explaining state and momentary decisions, I have yet to find good wording for it too. I had a bit of success by running a reviewer at the end to look over comments and docstrings and judge if it is "evergreen", but feels a bit like a rain-dance.