#30573: Don't assume that things are "easy"/"obvious"/"simple" in the docs.
-------------------------------------+-------------------------------------
Reporter: Tobias Kunze | Owner: Tobias
Type: | Kunze
Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"4a954cfd11a5d034491f87fcbc920eb97a302bb3" 4a954cf]:
{{{
#!CommitTicketReference repository=""
revision="4a954cfd11a5d034491f87fcbc920eb97a302bb3"
Fixed #30573 -- Rephrased documentation to avoid words that minimise the
involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:
- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous
Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30573#comment:8>
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 view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/062.ea470e6d935a2c2e7cbbbf63914a4098%40djangoproject.com.
