Skip to content

docs/mkOption: improve mkOption documentation #478096

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
Merged
hsjobeki merged 1 commit into from
Jan 15, 2026
Merged

docs/mkOption: improve mkOption documentation #478096

hsjobeki merged 1 commit into from
Jan 15, 2026

Conversation

@hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Jan 8, 2026 •
edited
Loading

  • Remove wrong .... sentence
  • Simplify wording around Attribute Set (remove duplicates, remove term structured because it doesn't add information)
  • Treat Option as opaque object in examples

Things done

  • Built on platform:
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • Tested, as applicable:
  • Ran nixpkgs-review on this PR. See nixpkgs-review usage.
  • Tested basic functionality of all binary files, usually in ./result/bin/.
  • Nixpkgs Release Notes
    • Package update: when the change is major or breaking.
  • NixOS Release Notes
    • Module addition: when adding a new NixOS module.
    • Module update: when the change is significant.
  • Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

Add a 👍 reaction to pull requests you find important.

@hsjobeki hsjobeki added the 6.topic: lib The Nixpkgs function library label Jan 8, 2026
@nixpkgs-ci nixpkgs-ci bot requested review from infinisil and roberth January 8, 2026 15:03
@nixpkgs-ci nixpkgs-ci bot added 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 6.topic: module system About "NixOS" module system internals labels Jan 8, 2026
roberth
roberth approved these changes Jan 8, 2026
View reviewed changes
Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

Good as is. Added suggestion.

@nixpkgs-ci nixpkgs-ci bot added the 12.approvals: 1 This PR was reviewed and approved by one person. label Jan 8, 2026
@hsjobeki hsjobeki enabled auto-merge January 9, 2026 08:48
@hsjobeki hsjobeki added this pull request to the merge queue Jan 15, 2026
Merged via the queue into NixOS:master with commit f98c968 Jan 15, 2026
47 of 50 checks passed
@hsjobeki hsjobeki deleted the doc-mkoption branch January 15, 2026 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@roberth roberth roberth approved these changes

@infinisil infinisil Awaiting requested review from infinisil

Assignees

No one assigned

Labels

6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-darwin: 1 This PR causes 1 package to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 12.approvals: 1 This PR was reviewed and approved by one person.

Projects

Nixpkgs Lib
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hsjobeki @roberth