Skip to content
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.

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

Fix docs regression, and removes workarounds #209

Merged
merged 2 commits into from Sep 29, 2020

Conversation

samueldr
Copy link
Member

The documentation could get stuck building from under our feet at any point a new option used the following form when defining an option default value.

default = "${pkgs.hello}";

"default" values in Nixpkgs manual can somehow be escaped by the
documentation back to their original string form.

The following ends up escaped into the manual as "${pkgs.hello}".

default = "${pkgs.hello}";

The methods for this magic have not been found.

Instead, we just change the default strict handleEvalIssue so that it
does absolutely nothing and lets them through.

Anyway we won't be building them.

"default" values in Nixpkgs manual can *somehow* be escaped by the
documentation back to their original string form.

The following ends up escaped into the manual as `"${pkgs.hello}"`.

```
default = "${pkgs.hello}";
```

The methods for this magic have not been found.

Instead, we just change the default strict `handleEvalIssue` so that it
does absolutely nothing and lets them through.

Anyway we won't be building them.
@samueldr samueldr merged commit afdc907 into NixOS:master Sep 29, 2020
@samueldr samueldr deleted the fix/docs-regression branch September 29, 2020 21:52
@samueldr samueldr added the 4. type: regression Something stopped working label Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4. type: regression Something stopped working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant