Recommend installing using the developer method for python.#387
Recommend installing using the developer method for python.#387
Conversation
WalkthroughThe documentation in the Python package installation file was updated by adding a warning block in the "Release install" section. This block now advises users to continue using the developer install method until version 0.6.0 is released, as version 0.5.0 is outdated and not fully available on pip. There were no modifications to the declarations of exported or public entities. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Python installation documentation to recommend using the developer install method over the release install for versions older than 0.6.0.
- Added a warning block in the installation docs emphasizing that 0.5.0 is outdated and users should use the developer install method until 0.6.0 is released.
Comments suppressed due to low confidence (1)
docs/source/installation/python-package.md:6
- [nitpick] Consider rewording the warning message for clarity. For example, instead of stating that 0.5.0 is 'heavily outdated and not fully released to pip', you could say 'Release installation via pip is not recommended until version 0.6.0 due to limitations in 0.5.0; please use the developer install method instead.'
Until we release 0.6.0 please continue to use the [developer install method](#development-install). 0.5.0 is
✅ Deploy Preview for jumpstarter-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/source/installation/python-package.md (1)
4-8: Effective Warning Block for Developer InstallThe new warning block is well-crafted and clearly informs users to continue using the developer install method until version 0.6.0 is released, given that version 0.5.0 is outdated and not fully available on pip. This messaging aligns with the PR objective.
Nitpick: Consider rephrasing slightly for enhanced clarity. For example, you might update the text to:
"Until version 0.6.0 is released, please use the developer install method, as version 0.5.0 is outdated and not fully available on pip."
This minor adjustment could improve readability and emphasize the rationale behind the recommendation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/installation/python-package.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: e2e
- GitHub Check: pytest-matrix (3.13)
- GitHub Check: pytest-matrix (3.11)
- GitHub Check: pytest-matrix (3.12)
- GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
- GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)
- GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
- GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-dev .devfile/Containerfile)
Summary by CodeRabbit