starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add docstrings for get_queryset overrides added in PR #18805 #10855

New Issue
Closed
opened 2025-12-29 21:36:47 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:36:47 +01:00
Owner
Copy Link

Originally created by @bctiemann on GitHub (Mar 6, 2025).

Originally assigned to: @bctiemann on GitHub.

Proposed Changes

Add docstrings:

    def get_queryset(self, request):
        """
        Reapply model-level ordering in case it has been lost through .annotate().
        https://code.djangoproject.com/ticket/32811
        """
        qs = super().get_queryset(request)
        ordering = qs.model._meta.ordering
        return qs.order_by(*ordering)

Justification

Without inline documentation this code might seem unnecessary and the risk of removing it is invisible.

Originally created by @bctiemann on GitHub (Mar 6, 2025). Originally assigned to: @bctiemann on GitHub. ### Proposed Changes Add docstrings: ``` def get_queryset(self, request): """ Reapply model-level ordering in case it has been lost through .annotate(). https://code.djangoproject.com/ticket/32811 """ qs = super().get_queryset(request) ordering = qs.model._meta.ordering return qs.order_by(*ordering) ``` ### Justification Without inline documentation this code might seem unnecessary and the risk of removing it is invisible.
adam added the type: housekeeping label 2025-12-29 21:36:47 +01:00
adam closed this issue 2025-12-29 21:36:47 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10855
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?