FilterLabels: off for unlabeled includes #345
Merged
Conversation
This file contains 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
raboof
reviewed
Aug 13, 2019
| @@ -393,7 +393,7 @@ case class SnipDirective(page: Page, variables: Map[String, String]) | |||
| try { | |||
| val labels = node.attributes.values("identifier").asScala | |||
| val source = resolvedSource(node, page) | |||
| val filterLabels = node.attributes.booleanValue("filterLabels", variables.get("snip.filterLabels").forall(_ == "true")) | |||
| val filterLabels = labels.nonEmpty && node.attributes.booleanValue("filterLabels", variables.get("snip.filterLabels").forall(_ == "true")) | |||
There was a problem hiding this comment.
Could we allow filtering out the labels when including a full file? Like:
- if a
filterLabelsattribute is present, use it - if not, and a
snip.filterLabelsdefault it set, use it - else,
labels.nonEmpty
?
(do you have a use for snip.filterLabels? might be simpler without that option)
There was a problem hiding this comment.
I made the local attribute take precedence and if nothing is defined labels.nonEmpty and the attribute control it.
(The global setting was there before, I didn't want to drop it.)
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.
Purpose
Disable label filtering for snippets/includes/fiddles which include a complete file.
Document the
filterLabelsflag and property.Background
Especially for snippets including whole HOCON files, label filtering often hides important lines with important information as
#is used for comments.One example is the
reference.confsnippet in https://doc.akka.io/docs/alpakka/1.1.1/dynamodb.html#setup