#30573: Don't assume that things are "easy"/"obvious"/"simple" in the docs
------------------------------------------------+--------------------------
Reporter: Tobias Kunze | Owner: nobody
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+--------------------------
Telling people in documentation that something is "easy" or "obvious" when
it isn't to them is very frustrating: It implies that the reader should
have a level of understanding they don't have, and doesn't add anything of
value in return. There are many occurrences of more-or-less obvious
instances of this pattern in the Django docs, and I'd like to reduce the
occurrence of this pattern.
--
Ticket URL: <https://code.djangoproject.com/ticket/30573>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/047.0cc8e72c57465460e0e1c60c93c92b37%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
