#35347: Clarify choice_set function in tutorial 2
-------------------------------------+-------------------------------------
Reporter: Lang Tran | Owner: Lang Tran
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Natalia Bidart):
Replying to [comment:7 Tim Graham]:
> I doubt it's a common source of confusion. "Django creates a set...
which can be accessed via the API." does all but name the set. We could
say something like, "Django creates a choice_set attribute on Question
instances..." but it feels a bit unnecessary when example usage follows
two lines later.
My understanding from the original report is that for someone new to
Django, it's not easy to make the connection that "''the set''" is
actually named `choice_set`. I know both things have the word "set" in it,
but I fear we may be too involved already in the project to not see the
connection (but newcomers may easily miss it).
I remember when I was learning Django, and seeing references to the
magical `something_set` attribute, and given my lack of experience and the
inevitable language barrier, I assume it to be a "weirdly named thing that
was like that just because a core dev did not like plurals" and not
because `_set` actually meant "''the set of [related] somethings''". More
so, when you read the tutorial in another language, "set" could be
translated to the proper term in that language so the connection is quite
challenging to be made, or worse, is not translated at all (because it's a
code comment) and the explanation is totally missed if the reader does not
understand English!
--
Ticket URL: <https://code.djangoproject.com/ticket/35347#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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018ea02abc2b-66ae6a73-6bc8-464a-9f51-a066691589f4-000000%40eu-central-1.amazonses.com.
