[Django] #32185: Add anchors to django code style docs
Django
-----------------------------------------+------------------------
Reporter: Stuart Axon | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 3.1
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 |
-----------------------------------------+------------------------
It would be good if there were anchors on all the subsections on here.
https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/coding-style/
Currently I can link to
https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/coding-style/#model-style
But I can't further link to the item about that starts
"The order of model inner classes and standard methods should be as
follows (noting that these are not all required):"
It would be useful for humans, but and possibly linters.
Source doc
https://github.com/django/django/blob/master/docs/internals/contributing
/writing-code/coding-style.txt
--
Ticket URL: <https://code.djangoproject.com/ticket/32185>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Stuart Axon | Owner: nobody
Cleanup/optimization |
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* status: new => closed
* resolution: => wontfix
* component: Uncategorized => Documentation
* type: Uncategorized => Cleanup/optimization
Comment:
Hi Stuart.
That whole model style section fits virtually within a single screen. TBH
I looked at in portrait first, where in fact it does. At that point, the
re-write to add additional anchor points for each list item is not worth
the additional linking accuracy. Just link to `#model-style`.
All the sections are pretty short. Python style is the longest, but even
that is less than two screens.
As such I have to say it's not worth the effort to implement, and
subsequent work for the translation teams.
Thanks.
--
Ticket URL: <https://code.djangoproject.com/ticket/32185#comment:1>