Improve documentation for name parameter of NotificationParameters#902
Open
kbuettner wants to merge 1 commit intoCheckmk:masterfrom
Open
Improve documentation for name parameter of NotificationParameters#902kbuettner wants to merge 1 commit intoCheckmk:masterfrom
kbuettner wants to merge 1 commit intoCheckmk:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
General information
Minor improvement to the docstring of rulesets.v1.rule_specs.NotificationParameters
Proposed changes
As opposed to the legacy API for notification parameters, NotificationParameters in the current API can no longer have identifiers such as notify-shmoo.py
The documentation is not clear about this, the resulting error in web.log upon trying to load such a param, however, is.
This change adds this rather useful bit of information to the documentation.