[Django] #33720: More instructive name in the doc example to help reading
Django
------------------------------------------------+------------------------
Reporter: Vlada Macek | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 4.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
Changing `django_blog` to `theme_blog` to match the class name `ThemeBlog`
will make the example clearer to read.
--
Ticket URL: <https://code.djangoproject.com/ticket/33720>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Vlada Macek | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: 4.0
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Description changed by Vlada Macek:
Old description:
> Changing `django_blog` to `theme_blog` to match the class name
> `ThemeBlog` will make the example clearer to read.
>
> https://github.com/django/django/blob/19297de2fe5a9c47e471c64249366f39fe12f16a/docs/topics/db/queries.txt#L1378
New description:
Changing `django_blog` to `theme_blog` to match the class name `ThemeBlog`
will make the example clearer to read.
8 occurrences of the term
--
--
Ticket URL: <https://code.djangoproject.com/ticket/33720#comment:1>
Django
-------------------------------------+-------------------------------------
Reporter: Vlada Macek | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: 4.0
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => wontfix
Comment:
In this example we create a theme blog called `Django`, so `django_blog`
sound appropriate to me.
--
Ticket URL: <https://code.djangoproject.com/ticket/33720#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: Vlada Macek | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 4.0
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* resolution: wontfix => invalid
--
Ticket URL: <https://code.djangoproject.com/ticket/33720#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Vlada Macek | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 4.0
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Vlada Macek):
Respectfully I disagree.
But of course refrain from pushing it further. :-)
I didn't even notice the name value. The class name is IMHO more important
to indicate to the new developers.
I raised the ticket, because the inheritance sub-issue discussed in the
paragraph was by itself pretty nontrivial for me to comprehend. :-)
--
Ticket URL: <https://code.djangoproject.com/ticket/33720#comment:4>