Skip to content

Clarify documentation for enable pseudo-variable#5659

Merged
kit-ty-kate merged 1 commit intoocaml:masterfrom
gridbugs:enable-doc
Nov 27, 2024
Merged

Clarify documentation for enable pseudo-variable#5659
kit-ty-kate merged 1 commit intoocaml:masterfrom
gridbugs:enable-doc

Conversation

@gridbugs
Copy link
Copy Markdown
Contributor

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.

@rjbou
Copy link
Copy Markdown
Collaborator

rjbou commented Sep 11, 2023

test in #5642 updated

Copy link
Copy Markdown
Collaborator

@rjbou rjbou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposed a rewording. The combination part is a specific note on enabled variable usage with combination; It should be put after the definition.

@kit-ty-kate kit-ty-kate removed this from the 2.2.0~alpha3 milestone Sep 11, 2023
@kit-ty-kate kit-ty-kate requested a review from rjbou September 25, 2024 10:16
@kit-ty-kate kit-ty-kate added this to the 2.4.0~alpha1 milestone Sep 25, 2024
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
Copy link
Copy Markdown
Member

Thanks!

@kit-ty-kate kit-ty-kate merged commit 359f072 into ocaml:master Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants