Correct the python version in the docs #359
Conversation
WalkthroughThe pull request updates the documentation for the software's Python version requirement, specifically changing the supported Python version from 3.8+ to 3.10+ in the Changes
Possibly related PRs
Poem
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.rst(1 hunks)
🔇 Additional comments (1)
docs/getting_started.rst (1)
9-9: Verify Python version requirement consistency across the codebaseThe Python version requirement has been updated to 3.10+. Let's ensure this is consistent with other configuration files and documentation.
Run the following script to check version requirements across the codebase:
✅ Verification successful
Python version requirement is correctly documented ✓
The Python 3.10+ requirement in
docs/getting_started.rstis consistent with:
- Project configuration in
pyproject.toml- Version information in
README.md- Package classifiers supporting Python 3.10, 3.11, and 3.12
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check Python version requirements across the codebase # Check setup.py/pyproject.toml for Python version echo "Checking setup.py and pyproject.toml..." fd -e py -e toml -g "*setup*|*project*" --exec rg -l "python|Python" # Check CI/CD configuration echo -e "\nChecking CI/CD configuration..." fd -e yml -e yaml -g "*ci*|*test*|*build*" --exec rg -l "python|Python" # Check other documentation files echo -e "\nChecking other documentation files..." fd -e rst -e md --exec rg -l "python.*3\.[0-9]|Python.*3\.[0-9]"Length of output: 509
Script:
#!/bin/bash # Get content of README.md and search for Python version references echo "=== README.md content ===" rg -A 2 -B 2 "python|Python" README.md # Search for other version requirement patterns echo -e "\n=== Additional version patterns ===" rg -l "py3|python3|\bpy\b|requires.*3\.|>=\s*3\." # Search for setup configuration with different patterns echo -e "\n=== Setup configuration ===" fd "setup.cfg|requirements.txt|pyproject.toml" --exec cat {}Length of output: 23927
| @@ -6,7 +6,7 @@ Getting Started | |||
| Requirements | |||
| ============ | |||
|
|
|||
| The main language is Python 3 and has been tested using Python 3.8+. Basic requirements are Numpy and Scipy. | |||
| The main language is Python 3 and has been tested using Python 3.10+. Basic requirements are Numpy and Scipy. | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document this breaking change more prominently
This is a breaking change that could affect users running Python 3.8 or 3.9. Consider adding migration notes or updating the changelog.
Add a note about the version change, for example:
The main language is Python 3 and has been tested using Python 3.10+. Basic requirements are Numpy and Scipy.
+
+.. note::
+ As of version X.Y.Z, SMACT requires Python 3.10 or higher. If you are using Python 3.8 or 3.9,
+ please use SMACT version X.Y.Z or earlier.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The main language is Python 3 and has been tested using Python 3.10+. Basic requirements are Numpy and Scipy. | |
| The main language is Python 3 and has been tested using Python 3.10+. Basic requirements are Numpy and Scipy. | |
| .. note:: | |
| As of version X.Y.Z, SMACT requires Python 3.10 or higher. If you are using Python 3.8 or 3.9, | |
| please use SMACT version X.Y.Z or earlier. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #359 +/- ##
==========================================
- Coverage 78.01% 75.95% -2.06%
==========================================
Files 31 31
Lines 2624 2624
==========================================
- Hits 2047 1993 -54
- Misses 577 631 +54 ☔ View full report in Codecov by Sentry. |
Correct the python version in the docs
Description
Type of change
How Has This Been Tested?
N/A
Test Configuration:
Reviewers
@AntObi
Checklist
Summary by CodeRabbit
Release Notes