Fixes #19255: Improved documentation consistency for configuration default values #19258
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mr1716
changed the title
mr1716
changed the title
jeremystretch
requested changes
Apr 24, 2025
docs/configuration/plugins.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| ## PLUGINS | |||
|
|
|||
| Default: Empty | |||
| Default: `Empty` | |||
There was a problem hiding this comment.
"Empty" isn't a literal value. We should either leave this as is, or change it to "[] (empty)"
There was a problem hiding this comment.
@jeremystretch thanks. Will switch it to []
docs/configuration/plugins.md
Outdated
| @@ -13,7 +13,7 @@ A list of installed [NetBox plugins](../plugins/index.md) to enable. Plugins wil | |||
|
|
|||
| ## PLUGINS_CONFIG | |||
|
|
|||
| Default: Empty | |||
| Default: `Empty` | |||
There was a problem hiding this comment.
Similar to PLUGINS above, but this is an empty dictionary by default.
There was a problem hiding this comment.
@jeremystretch thanks. Will switch it to []
docs/configuration/system.md
Outdated
| @@ -206,14 +206,14 @@ If `STORAGE_BACKEND` is not defined, this setting will be ignored. | |||
|
|
|||
| ## TIME_ZONE | |||
|
|
|||
| Default: UTC | |||
| Default: `UTC` | |||
There was a problem hiding this comment.
It might help to represent this explicitly as a string to avoid confusion with a global constant.
Suggested change
| Default: `UTC` | |
| Default: `"UTC"` |
There was a problem hiding this comment.
@jeremystretch thanks. Change made
|
@jeremystretch requested changes made. Thanks for the review and happy to change as otherwise needed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #19255
The changes ensure that the default values are highlighted the same way in the documentation