Skip to content

lib.options: automatically generate example for booleans #18816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
groxxda wants to merge 2 commits into from
Closed

lib.options: automatically generate example for booleans #18816

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c0c65d
lib.options: automatically generate example for types.bool
groxxda Sep 21, 2016
d592d90
lib.options: automatically generate example if default is a bool
groxxda Sep 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions lib/options.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,24 @@ rec {
visible = opt.visible or true;
readOnly = opt.readOnly or false;
type = opt.type.name or null;
}
// (if opt ? example then { example = scrubOptionValue opt.example; } else {})
// (if opt ? default then { default = scrubOptionValue opt.default; } else {})
// (if opt ? defaultText then { default = opt.defaultText; } else {});
};
docOptionDefault =
if opt ? defaultText then { default = opt.defaultText; }
else if opt ? default then { default = scrubOptionValue opt.default; }
else { };
docOptionExample =
if opt ? example then { example = scrubOptionValue opt.example; }
else if opt.type == lib.types.bool then
{ example = !docOptionDefault.default or false; }
Copy link
Member

@nbp nbp Oct 31, 2016

Choose a reason for hiding this comment

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

nit: !(docOptionDefault.default or false)

Copy link
Contributor Author

@groxxda groxxda Oct 31, 2016

Choose a reason for hiding this comment

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

I'll change that to improve readability.

else if opt ? type && isBool (docOptionDefault.default or null) && opt.type.check (!docOptionDefault.default) then
Copy link
Member

@nbp nbp Oct 31, 2016

Choose a reason for hiding this comment

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

In opt.type.check (!docOptionDefault.default), the attribute default might not exists, and raise an error.

Copy link
Contributor Author

@groxxda groxxda Oct 31, 2016

Choose a reason for hiding this comment

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

That should never happen since it's only evaluated if isBool (docOptionDefault.default or null)

{ example = !docOptionDefault.default or false; }
Copy link
Member

@nbp nbp Oct 31, 2016

Choose a reason for hiding this comment

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

nit: !(… or …)
nit: factor this expression in a let … in ….

Copy link
Contributor Author

@groxxda groxxda Oct 31, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

I'll check if I can factor that out, but I'd rather not add a let.
Reading it again it's strange I check for opt.type == bool and in the else case check opt ? type. This looks wrong 😕

else { };

subOptions =
let ss = opt.type.getSubOptions opt.loc;
in if ss != {} then optionAttrSetToDocList' opt.loc ss else [];
in
[ docOption ] ++ subOptions) (collect isOption options);
[ (docOption // docOptionDefault // docOptionExample) ] ++ subOptions) (collect isOption options);


/* This function recursively removes all derivation attributes from
Expand Down