Skip to content

Conversation

@yanziz-nvidia
Copy link
Contributor

Description

Adds --seed in the command for uv to install pip. Otherwise subsequent uv workflow uses system default pip which results in errors.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 23, 2025
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 23, 2025

Greptile Summary

Added the --seed flag to uv venv commands in the virtual environment setup documentation to fix a critical workflow issue where subsequent uv operations would incorrectly use the system's default pip instead of the virtual environment's pip, causing installation errors.

Key changes:

  • Updated both Linux and Windows uv venv command examples to include --seed flag
  • Updated comments to clarify that the command creates a virtual environment with pip included

Note: The same uv venv commands in docs/source/setup/quickstart.rst may also need this fix to ensure consistency across all documentation.

Confidence Score: 4/5

  • This PR is safe to merge with minimal risk - it's a documentation fix that resolves a real workflow issue
  • The change is technically correct and addresses a legitimate bug where uv would fall back to system pip without the --seed flag. Score of 4 instead of 5 because the same issue exists in quickstart.rst that should ideally be fixed in the same PR for consistency
  • Check docs/source/setup/quickstart.rst for similar updates needed

Important Files Changed

Filename Overview
docs/source/setup/installation/include/pip_python_virtual_env.rst Added --seed flag to uv venv commands to ensure pip is installed in the virtual environment, preventing workflow errors

Sequence Diagram

sequenceDiagram
    participant User
    participant Documentation
    participant UV as uv (Package Manager)
    participant VirtualEnv as Virtual Environment
    participant Pip

    User->>Documentation: Read setup instructions
    
    rect rgb(240, 240, 240)
        note right of User: Before fix (broken workflow)
        User->>UV: uv venv --python 3.11 env_isaaclab
        UV->>VirtualEnv: Create virtual environment
        Note over VirtualEnv: No pip installed
        User->>Pip: Run pip commands
        Pip-->>User: Error: Uses system pip instead
    end
    
    rect rgb(220, 255, 220)
        note right of User: After fix (working workflow)
        User->>UV: uv venv --python 3.11 --seed env_isaaclab
        UV->>VirtualEnv: Create virtual environment
        UV->>Pip: Install pip in venv
        Note over VirtualEnv,Pip: pip properly installed
        User->>Pip: Run pip commands
        Pip-->>User: Success: Uses venv pip
    end
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Additional Comments (1)

  1. docs/source/setup/installation/include/pip_python_virtual_env.rst, line 48-49 (link)

    style: Check that the same uv venv commands in docs/source/setup/quickstart.rst (lines 54 and 64) also have the --seed flag to prevent the same workflow error

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@yanziz-nvidia yanziz-nvidia force-pushed the yanziz/uv-pip-missing-doc branch from a80deb5 to 0659e51 Compare December 23, 2025 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant