Skip to content

Update shellFor documentation #2406

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

Merged
merged 2 commits into from
Jul 3, 2025
Merged

Update shellFor documentation #2406

merged 2 commits into from
Jul 3, 2025

Conversation

hamishmack
Copy link
Collaborator

Fixes #2401

@hamishmack hamishmack requested a review from Copilot July 2, 2025 23:23
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation and a module description for the shellFor feature, and records the change in the changelog.

  • Fix a typo in the modules/shell.nix description for the allToolDeps default behavior.
  • Expand the shellFor argument table in docs/reference/library.md, adding new options and usage examples.
  • Add a changelog entry to explain the new argument validation for shellFor.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
modules/shell.nix Corrected typo in description of allToolDeps default value.
docs/reference/library.md Added and reorganized shellFor table entries; included examples.
changelog.md Documented the updated shellFor argument validation behavior.
Comments suppressed due to low confidence (3)

docs/reference/library.md:446

  • The Type column for buildInputs is empty in the table. Consider specifying its type (e.g., List or AttrSet).
| `buildInputs`  | | Passed to [`mkDerivation`](https://nixos.org/nixpkgs/manual/#sec-using-stdenv) (via [mkShell](https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-mkShell)). |

docs/reference/library.md:447

  • The Type column for nativeBuildInputs is empty in the table. Consider specifying its type (e.g., List or AttrSet).
| `nativeBuildInputs` | | Passed to [`mkDerivation`](https://nixos.org/nixpkgs/manual/#sec-using-stdenv) (via [mkShell](https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-mkShell)). |

docs/reference/library.md:448

  • The Type column for passthru is empty in the table. Consider specifying its type (e.g., AttrSet).
| `passthru`     | | Passed to [`mkDerivation`](https://nixos.org/nixpkgs/manual/#sec-using-stdenv)  (via [mkShell](https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-mkShell)). |

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@hamishmack hamishmack requested a review from angerman July 2, 2025 23:25
@hamishmack hamishmack merged commit 71a34a6 into master Jul 3, 2025
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can't set environment variables in shellFor any more
2 participants