Minor update to sparse checkout doc.

materialsproject · May 17, 2023 · ba1be53 · ba1be53
1 parent 3e3c31c
commit ba1be53
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/contributing.html b/docs/contributing.html
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs_rst/contributing.rst b/docs_rst/contributing.rst
@@ -42,10 +42,10 @@ Direct contributions to pymatgen main distribution
       git clone -n --depth=1 --filter=tree:0 [email protected]:materialsproject/pymatgen.git
       cd pymatgen
 
-      # if you have Git 2.25+, you can use the sparse-checkout command.
+      # If you have Git 2.25+ (released 2023-01-01), you can use the sparse-checkout command (uncomment the next line).
       # git sparse-checkout set --no-cone pymatgen setup.py pyproject.toml requirements.txt requirements-optional.txt
 
-      # The code below should work for any git after 2012.
+      # If you are on a system with an older version of git, run the commands below.
       git config core.sparseCheckout true
       echo pymatgen >> .git/info/sparse-checkout
       echo setup.py >> .git/info/sparse-checkout