Simple docs update #1178
Open
Simple docs update #1178
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
…s from the CLI, common CLI flags, and clarified error messages related to module-root and benchmarks. Updated VS Code extension setup instructions for better clarity.
Contributor
|
@mashraf-222 The docs used to create a staging link for review earlier. Not sure why it doesnt create in PR reviews now. |
Saga4
reviewed
Jan 29, 2026
| 3. **Optimize Button** — Click the **Optimize** button (with lightning bolt icon) to queue the selected function for optimization | ||
| 1. **FILE** — pick a Python file from your workspace. | ||
| 2. **FUNCTION/METHOD** — pick a specific function or method in that file. | ||
| 3. **Optimize** — click the lightning button to queue that function for optimization. |
Contributor
There was a problem hiding this comment.
We can add a lightning button emoji here
Saga4
reviewed
Jan 29, 2026
|
|
||
| 3. **Optimize Button** — Click the **Optimize** button (with lightning bolt icon) to queue the selected function for optimization | ||
| 1. **FILE** — pick a Python file from your workspace. | ||
| 2. **FUNCTION/METHOD** — pick a specific function or method in that file. |
Contributor
There was a problem hiding this comment.
here the file which user is looking if its not part of the module path that can cause them strangled.
Saga4
reviewed
Jan 29, 2026
| - **`--file PATH`**: Optimize only this file. | ||
| - **`--function NAME`**: Optimize only this function (requires `--file`). | ||
| - **`--all [PATH]`**: Optimize all functions, optionally under a path. | ||
| - **`--no-pr`**: Apply changes locally instead of creating a pull request. |
Contributor
There was a problem hiding this comment.
nit: Adding examples for each would be helpful with placeholder I guess.
Saga4
approved these changes
Jan 29, 2026
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.
No description provided.