Clarify documentation for enable pseudo-variable
#5659
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
kit-ty-kate
reviewed
Sep 11, 2023
The documentation for variables says that for boolean variables the form `name1+name2+name3:var` is equivalent to `name1:var & name2:var & name3:var` but it's possible to write `name1+name2:enable` despite `enable` being the string "enable" or "disable". This change clarifies that `enable` isn't really a variable but syntactic sugar instead.
kit-ty-kate
force-pushed
the
enable-doc
branch
from
efff965
to
0b84e2e
Compare
kit-ty-kate
approved these changes
Sep 11, 2023
rjbou
reviewed
Sep 11, 2023
Comment on lines
+495
to
+499
| - <a id="pkgvar-enable">`enable`</a>: is not a variable. | ||
| `pkg1+pkg2+...+pkgN:enable` is syntactic sugar for | ||
| `pkg1+pkg2+...+pkgN:installed?enable:disable`. That is, it behaves like a | ||
| variable that takes the value "enable" or "disable" depending on whether the | ||
| package(s) are installed |
There was a problem hiding this comment.
Suggested change
| - <a id="pkgvar-enable">`enable`</a>: is not a variable. | |
| `pkg1+pkg2+...+pkgN:enable` is syntactic sugar for | |
| `pkg1+pkg2+...+pkgN:installed?enable:disable`. That is, it behaves like a | |
| variable that takes the value "enable" or "disable" depending on whether the | |
| package(s) are installed | |
| - <a id="pkgvar-enable">`enable`</a>: | |
| takes the value "enable" or "disable" depending on whether the package is | |
| installed. Used with the combination operator `+`, | |
| `name1+name2+name3:enable` is syntactic sugar for | |
| `name1+name2+name3:installed?enable:disable`. |
There was a problem hiding this comment.
- Used with combination operator `+`,
+ Used with the combination operator `+`,
|
test in #5642 updated |
rjbou
requested changes
Sep 11, 2023
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.
The documentation for variables says that for boolean variables the form
name1+name2+name3:varis equivalent toname1:var & name2:var & name3:varbut it's possible to writename1+name2:enabledespiteenablebeing the string "enable" or "disable". This change clarifies thatenableisn't really a variable but syntactic sugar instead.