3 ms·
I've been trying to teach myself not to use the word "just" in my documentation. I was inspired by this legendary PR to the Django docs that fixed all kinds of
by simonw 4y ago
I've been trying to teach myself not to use the word "just" in my documentation.
I was inspired by this legendary PR to the Django docs that fixed all kinds of words that "minimize difficulty involved": https://github.com/django/django/pull/11482 https://github.com/django/django/pull/11482
- justin_oaks 4y agoAwesome. It's one of my pet peeves to see "just" or "simply" and similar words in documentation. It makes the documentation clearer and less condescending to remove words that imply a task is easy. Implying a task is easy doesn't help people to perform the task. It's especially frustrating when the documentation is incomplete, as most documentation is. For example, "If you need different behavior, just implement a custom component" ... and the custom component documentation is incomplete or missing. sigh