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

Spurious docstring appears in API docs #7208

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

Originally created by @candlerb on GitHub (Nov 9, 2022).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.3.7

Python version

3.8

Steps to Reproduce

  1. Go to /api/docs/
  2. Scroll down to GET /dcim/devices/ (dcim_devices_list) and expand

Expected Behavior

Either a meaningful description of what /dcim/devices/ does, or no comment.

Observed Behavior

A comment has been picked up from the source code which isn't meaningful here: "Overrides ListModelMixin to allow processing ExportTemplates."

image

Perhaps this should be changed from a docstring to a regular comment?

Originally created by @candlerb on GitHub (Nov 9, 2022). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.3.7 ### Python version 3.8 ### Steps to Reproduce 1. Go to `/api/docs/` 2. Scroll down to `GET /dcim/devices/ (dcim_devices_list)` and expand ### Expected Behavior Either a meaningful description of what `/dcim/devices/` does, or no comment. ### Observed Behavior A comment has been picked up from the source code which isn't meaningful here: "Overrides ListModelMixin to allow processing ExportTemplates." ![image](https://user-images.githubusercontent.com/44789/200775440-fb586991-e82f-46c0-8887-dd5d1e4837c5.png) Perhaps this should be changed from a docstring to a regular comment?
adam added the status: acceptedtype: documentation labels 2025-12-29 20:20:28 +01:00
adam closed this issue 2025-12-29 20:20:29 +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 status: accepted type: documentation
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#7208
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?