doc: Add documentation about comments in PromQL#6198
Merged
brian-brazil merged 2 commits intoprometheus:masterfrom Oct 25, 2019
Merged
doc: Add documentation about comments in PromQL#6198brian-brazil merged 2 commits intoprometheus:masterfrom
brian-brazil merged 2 commits intoprometheus:masterfrom
Conversation
Signed-off-by: Tobias Guggenmos <tguggenm@redhat.com>
Contributor
|
Adding tests first would be good, and I'd put this down the end of the docs as it's quite rarely used. |
Signed-off-by: Tobias Guggenmos <tguggenm@redhat.com>
Contributor
|
Thanks! |
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
2 participants
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.
Signed-off-by: Tobias Guggenmos tguggenm@redhat.com
TIL that prometheus actually supports comments, while reading the parser code. This is also mentioned in #2855.
This PR documents this.
However this feature isn't tested in the parser tests, so it might make sense to add such tests before telling everybody about it.