Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct the python version in the docs #359

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Correct the python version in the docs #359

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
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.

The `Atomic Simulation Environment <https://wiki.fysik.dtu.dk/ase>`_
(ASE), `spglib <http://atztogo.github.io/spglib>`_,
and `pymatgen <http://pymatgen.org>`_ are also required for many components.
Expand Down
Loading