-
Notifications
You must be signed in to change notification settings - Fork 210
docs: reuse Makefile targets in CI and simplify AGENTS.md #3825
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
FBruzzesi
merged 7 commits into
narwhals-dev:docs/AGENTS-md
from
EdAbati:docs/agents-md-edo
Jul 30, 2026
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
72f76e7
add some useful commands
EdAbati 27a43cd
reuse commands in CI
EdAbati 3969959
Update CONTRIBUTING.md
EdAbati a31274e
simplify agents
EdAbati d5519f8
better description
EdAbati c3dd828
Update Makefile
EdAbati 7d709d0
Update Makefile
EdAbati File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,8 @@ If you've got experience with open source contributions, the following instructi | |
| - `uv sync --group local-dev` (creates `.venv` and installs project + dev deps) | ||
| - Install prek as a git hook: `uv run prek install` | ||
| - To run tests: `uv run pytest` | ||
| - To run all linting checks: `make lint` | ||
| - To run ruff formatting and linting: `make lint` | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. technically make lint does NOT "run all linting checks" :) |
||
| - To run all pre-commit checks (which include ruff): `uv run prek run --all-files` | ||
| - To run static typing checks: `make typing` | ||
|
|
||
| For more detailed and beginner-friendly instructions, see below! | ||
|
|
@@ -332,6 +333,8 @@ The docs should refresh when you make changes. If they don't, press `ctrl+C`, an | |
| make docs-clean-serve | ||
| ``` | ||
|
|
||
| which rebuilds everything from a clean state (via `make docs-build`) before serving. | ||
|
|
||
| ### 10. Pull requests | ||
|
|
||
| When you have resolved your issue, [open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) in the Narwhals repository. | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,25 +23,37 @@ typing: ## Run type checkers | |
| typing-coverage: ## Run type checkers | ||
| uv run --group typing pyrefly coverage check src/narwhals --public-only | ||
|
|
||
| .PHONY: docs-build | ||
| docs-build: ## Build the docs locally | ||
| uv run --group docs zensical build --clean | ||
| .PHONY: docs-dynamic-content | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to make it reusable |
||
| docs-dynamic-content: ## Regenerate the dynamic docs pages (API completeness tables, docs/this.md, ...) | ||
| uv run --group docs --extra dask --extra ibis utils/generate_backend_completeness.py | ||
| uv run --group docs utils/generate_zen_content.py | ||
| uv run --group docs zensical build --strict | ||
|
|
||
| .PHONY: docs-build | ||
| docs-build: docs-dynamic-content ## Build the docs from a clean state, failing on warnings | ||
| uv run --group docs zensical build --clean --strict | ||
|
EdAbati marked this conversation as resolved.
|
||
|
|
||
| .PHONY: docs-serve | ||
| docs-serve: ## Build and serve the docs locally | ||
| uv run --group docs --extra dask --extra ibis utils/generate_backend_completeness.py | ||
| uv run --group docs utils/generate_zen_content.py | ||
| docs-serve: docs-dynamic-content ## Serve the docs locally | ||
| uv run --group docs zensical serve | ||
|
EdAbati marked this conversation as resolved.
Outdated
|
||
|
|
||
| .PHONY: docs-clean-serve | ||
| docs-clean-serve: ## Rebuild docs from a clean state and serve them locally | ||
| uv run --group docs zensical build --clean | ||
| $(MAKE) docs-serve | ||
| $(MAKE) docs-build | ||
| uv run --group docs zensical serve | ||
|
|
||
| .PHONY: run-ci | ||
| run-ci: ## Print resolved deps, then run a command via uv. Usage: make run-ci DEPS="<groups/extras>" CMD="<command>" [RUN_ONLY="<uv-run-only flags, e.g. --isolated, --with X, --no-sync>"] | ||
| uv export --no-annotate --no-hashes $(DEPS) | ||
| uv run $(DEPS) $(RUN_ONLY) $(CMD) | ||
|
|
||
| .PHONY: doctest | ||
| doctest: ## Run doctests | ||
| make run-ci \ | ||
| DEPS="--extra pandas --extra dask --group core-tests --group sklearn" \ | ||
| CMD="pytest src --doctest-modules" | ||
|
|
||
| .PHONY: test-full-coverage | ||
| test-full-coverage: ## Run the full test suite with 100% coverage across all constructors as in CI | ||
| PYTEST_ADDOPTS="--numprocesses=logical" make run-ci \ | ||
| DEPS="--extra pandas --extra dask --group core-tests --group sklearn --group plugins" \ | ||
| CMD="pytest tests --cov=src --cov=tests --cov-fail-under=100 --runslow --durations=30 --constructors=pandas,pandas[nullable],pandas[pyarrow],pyarrow,polars[eager],polars[lazy],dask,duckdb,sqlframe" | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was a bit too long for the agent IMO