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

lib.fixedPoints.extends: document order of invocation #245825

Closed
wants to merge 1 commit into from
Closed

lib.fixedPoints.extends: document order of invocation #245825

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Jul 28, 2023

Description of changes

The description for lib.fixedPoints.extends is very hard to understand. I read it a few times trying to figure out "in what order are its arguments applied by the resulting function?" and couldn't figure that out. So I added the answer to that question in a comment.

I don't think the allusion to Java is particularly helpful.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

The description for lib.fixedPoints.extends is very hard to
understand.  I read it a few times trying to figure out "in what
order are its arguments applied by the resulting function?" and
couldn't figure that out.  So I added the answer to that question in
a comment.

I don't think the allusion to Java is particularly helpful.
@github-actions github-actions bot added the 6.topic: lib The Nixpkgs function library label Jul 28, 2023
@ghost ghost marked this pull request as ready for review July 28, 2023 06:21
@ghost ghost requested review from edolstra and infinisil as code owners July 28, 2023 06:21
@infinisil
Copy link
Member

I think that documentation needs a complete rewrite, it's overly convoluted. I made an attempt of that here: #248220

@ghost ghost closed this Oct 22, 2023
@ghost ghost deleted the pr/lib/fixed-points/extends branch October 22, 2023 05:37
This pull request was closed.
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.

1 participant