docs: fix broken nix command and stale references in contributor docs - #6129
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four stale or incorrect references in the contributor docs, each checked against the code or run in a shell.
web/book/src/project/contributing/development.mdThe nix setup command doesn't work. Step 2 of "Option 4: Use nix development environment" says
tee 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf.tee's argument is a filename, not content — so this creates a file literally namedexperimental-features = nix-command flakesin the current directory, blocks reading stdin from the terminal, and leavesnix.confempty. Anyone following the nix path today gets no flakes and a junk file. Changed toecho.Python version is two releases behind. The doc says "ensure we have Python >= 3.7";
prqlc-python/pyproject.tomldeclaresrequires-python = ">=3.9"."GitHub Actions on merge" points at a deleted workflow. The link was SHA-pinned to
c042eef4's.github/workflows/pull-request.yaml#L124; that file no longer exists onmain. Push-to-maintest runs are nowtests.yaml, which declarespush: branches: [main]and gates the wider matrix through therulesjob'smainoutput — so the surrounding prose still describes real behavior, just via a different file. Repointed totests.yaml. Left unpinned deliberately: it's a whole-file reference with no line anchor, and the intent is "wherever this lives now".CLAUDE.mdIntegration test path is missing a directory level. It reads
prqlc/tests/integration/queries/*.prql; the actual location isprqlc/prqlc/tests/integration/queries/.prqlc/tests/doesn't exist. Same class of slip as #6108, one directory up.The doc-viewing snippet invokes a
Viewtool that doesn't exist. Claude Code's file-reading tool isRead; there is noView. Following the snippet as written fails.Verification
The
teebehavior, run in a scratch directory:Both files are 0 bytes — the setting never reaches
nix.conf. (< /dev/nullstands in for the terminal here; interactively it would hang instead.)Paths:
requires-pythonis read directly frompyproject.toml(linked above).No regression test. These are all prose and link fixes with no executable surface; the shell transcripts above are the check. The one testable claim — the missing directory level in
CLAUDE.md— is verified by thetest -dpair.