Skip to content

[Doc] Update SKILL.md to support editable installs and clarify develo…#2533

Open
erhsh wants to merge 1 commit into
tile-ai:mainfrom
easy-tilelang:main_bugfix
Open

[Doc] Update SKILL.md to support editable installs and clarify develo…#2533
erhsh wants to merge 1 commit into
tile-ai:mainfrom
easy-tilelang:main_bugfix

Conversation

@erhsh

@erhsh erhsh commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

…pment workflow

Updated SKILL.md to clarify the development workflow for editable installs.

  • Explicitly documents that pip install -e . is supported.
  • Adds a concrete editable-install command sequence for development use.
  • Clarifies repo-specific import behavior in tilelang/env.py, including where native libraries are loaded from in a dev checkout.
  • Replaces the previous warning against editable installs with guidance aligned to the contributor/readme docs.

C++ style / lint notes

  • This PR does not touch C++ code, CI, lint tooling, or C++ style documentation.
  • The C++ API Style Audit (warning only) is not relevant here.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

👋 Hi! Thank you for contributing to the TileLang project.

Please remember to run pre-commit run --all-files in the root directory of the project to ensure your changes are properly linted and formatted. This will help ensure your contribution passes the format check.

We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated the "Editable Installs" section of the tilelang-build skill documentation, removing a warning against pip install -e . and replacing it with guidance supporting editable installs, including recommended commands and notes on import behavior via tilelang/env.py.

Changes

Documentation update

Layer / File(s) Summary
Editable Installs section rewrite
.agents/skills/tilelang-build/SKILL.md
Replaces the prior warning against pip install -e . with guidance documenting it as supported, adding concrete install commands and notes on how repo-root imports resolve via tilelang/env.py.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: None identified.

🐰 A rabbit hops through docs with glee,
"Editable installs? Now they're free!"
No more warnings, stern and tight,
Just pip install -e . done right.
A hop, a nibble, docs anew — 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main doc change: enabling editable installs and clarifying the development workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.agents/skills/tilelang-build/SKILL.md (1)

76-78: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Clarify the scope of the PYTHONPATH comparison.

pip install -e . and PYTHONPATH=$(pwd) both make imports resolve to the local checkout from the repo root, but they are not equivalent beyond import lookup. The current wording reads as if either choice is interchangeable in general, which can confuse contributors about metadata and dependency handling.

Suggested wording
- - Because of the above, an editable install and a plain `PYTHONPATH=$(pwd)` import resolve to the same on-disk `./tilelang`. Either is fine; pick based on whether you want pip to manage metadata/deps.
+ - Because of the above, both approaches resolve imports to the local `./tilelang` when run from the repo root. Use `pip install -e .` when you want pip to manage package metadata/dependencies; use `PYTHONPATH=$(pwd)` only for the lighter-weight import-only workflow.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/tilelang-build/SKILL.md around lines 76 - 78, Clarify in
SKILL.md that `pip install -e .` and `PYTHONPATH=$(pwd)` are only equivalent for
importing the local `tilelang` checkout from the repo root, not for environment
management. Update the wording around the `tilelang/env.py` dev-checkout
behavior and the `cmake + PYTHONPATH` note to explicitly say that pip editable
installs handle metadata and dependencies, while `PYTHONPATH` only affects
import resolution.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In @.agents/skills/tilelang-build/SKILL.md:
- Around line 76-78: Clarify in SKILL.md that `pip install -e .` and
`PYTHONPATH=$(pwd)` are only equivalent for importing the local `tilelang`
checkout from the repo root, not for environment management. Update the wording
around the `tilelang/env.py` dev-checkout behavior and the `cmake + PYTHONPATH`
note to explicitly say that pip editable installs handle metadata and
dependencies, while `PYTHONPATH` only affects import resolution.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 00e8aeab-323c-4b25-85d1-59e493e4ae47

📥 Commits

Reviewing files that changed from the base of the PR and between 16af6f8 and ee28e41.

📒 Files selected for processing (1)
  • .agents/skills/tilelang-build/SKILL.md

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.

2 participants