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.

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

Jump to bottom

nixos/nixpkgs/docs: fix typo in assertOneOf example #105492

Merged
merged 1 commit into from Feb 7, 2021
Merged

nixos/nixpkgs/docs: fix typo in assertOneOf example #105492

merged 1 commit into from Feb 7, 2021

Conversation

alunduil
Copy link
Contributor

This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either. This ensures the example is consistent
with the logic being presented.

Motivation for this change

Fixing a typo in the NixOS manual where an example is slightly confusing due to the wrong entry.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@alunduil
nixos/nixpkgs/docs: fix typo in assertOneOf example
195fe01 
This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either.  This ensures the example is consistent
with the logic being presented.
fricklerhandwerk
fricklerhandwerk approved these changes Dec 4, 2020
View reviewed changes
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

Had to read it twice, but yes, you are right. LGTM

@doronbehar doronbehar merged commit c858d0f into NixOS:master Feb 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fricklerhandwerk fricklerhandwerk fricklerhandwerk approved these changes

@doronbehar doronbehar doronbehar approved these changes

Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@alunduil @fricklerhandwerk @doronbehar