Opened 3 years ago

Closed 3 years ago

#32185 closed Cleanup/optimization (wontfix)

Add anchors to django code style docs

Reported by: Stuart Axon Owned by: nobody
Component: Documentation Version: 3.1
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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

Change History (1)

comment:1 by Carlton Gibson, 3 years ago

Component: UncategorizedDocumentation
Resolution: wontfix
Status: newclosed
Type: UncategorizedCleanup/optimization

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.

Note: See TracTickets for help on using tickets.
Back to Top