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

Custom scripts docs: repetition of optional variables #5023

New Issue
Closed
opened 2025-12-29 19:23:16 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:23:16 +01:00
Owner
Copy Link

Originally created by @bluikko on GitHub (Jun 23, 2021).

Change Type

Cleanup (formatting, typos, etc.)

Area

Functionality/features

Proposed Changes

The documentation repeats two times the optionality of variables:

Variables allow your script to accept user input via the NetBox UI, but they are optional: If your script does
not require any user input, there is no need to define any variables.

and

Defining script variables is optional: You may create a script with only a `run()` method if no user input is needed.

This seems to me like a repetition of the same statement.

I am unsure which one would be better to keep so the PR just takes one at random.

Originally created by @bluikko on GitHub (Jun 23, 2021). ### Change Type Cleanup (formatting, typos, etc.) ### Area Functionality/features ### Proposed Changes The documentation repeats two times the optionality of variables: ``` Variables allow your script to accept user input via the NetBox UI, but they are optional: If your script does not require any user input, there is no need to define any variables. ``` and ``` Defining script variables is optional: You may create a script with only a `run()` method if no user input is needed. ``` This seems to me like a repetition of the same statement. I am unsure which one would be better to keep so the PR just takes one at random.
adam added the type: documentation label 2025-12-29 19:23:16 +01:00
adam closed this issue 2025-12-29 19:23:16 +01:00
adam commented 2025-12-29 19:23:17 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 23, 2021):

This is fine. It's often beneficial, even necessary, to repeat things in documentation.

@jeremystretch commented on GitHub (Jun 23, 2021): This is fine. It's often beneficial, even necessary, to repeat things in documentation.
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: 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#5023
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?