docs: apply feedback, update the docs

eduNEXT · Nov 14, 2024 · 8d21d9a · 8d21d9a
1 parent 56d00c7
commit 8d21d9a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ A library of graders for edX Custom Response problems.
 
 Version 2.4.1 ([changelog](docs/changelog.md))
 
-Copyright 2024 Jolyon Bloomfield and Chris Chudzicki
+Copyright 2017-2024 Jolyon Bloomfield and Chris Chudzicki
 
 Licensed under the [BSD-3 License](LICENSE).
 
@@ -39,7 +39,7 @@ To install:
 
 0. (Optional) Create and activate a new Python Virtual Environment.
 1. Clone this repository and `cd` into it.
-2. Run `pip install -r requirements.txt` to install the requirements specified in `requirements.txt`.
+2. Run `pip install -r requirements-python38.txt` or `pip install -r requirements-python311.txt` to install the requirements based on the Python version you want to test.
 3. Run `pytest` to check that tests are passing. (To invoke tests of just the documentation, you can run the following command: `python -m pytest --no-cov --disable-warnings docs/*`)
 
 

diff --git a/docs/edx.md b/docs/edx.md
@@ -120,4 +120,4 @@ We want to stress the simplicity of this example compared to implementing the sa
 
 ## Note on Python Version
 
-Older versions of edX used python 2.7 in custom graders, while newer versions use python 3.5. The library works seamlessly with both versions, although some matrix math functionality requires python 3.5. The python version is automatically selected by the edX server. No changes to the XML code are required to work with either version of python.
+The Python version is automatically selected by the edX server. No changes to the XML code are required.
diff --git a/docs/faq.md b/docs/faq.md
@@ -6,4 +6,4 @@ Unfortunately, no. Those problem types cannot be used in a `customresponse` prob
 
 - Does the grader work with python 2 or python 3?
 
-It works with both! Older versions of edX ran python graders in python 2.7; newer versions use python 3.5. The library works seamlessly with both. No changes to any code are required to switch between versions. Some functionality requires python 3.5 however.
+It works with both! Older versions of edX ran python graders in python 2.7; newer versions use python 3.8. The library works seamlessly with both. No changes to any code are required to switch between versions. Some functionality requires python 3.5 however.
diff --git a/docs/index.md b/docs/index.md
@@ -20,7 +20,7 @@ Use MITxGraders because it:
 - is reliable (extensively tested)
 - is open source (BSD-3 license, [our Github repo](https://github.com/mitodl/mitx-grading-library))
 - has an [excellent example edX course](https://edge.edx.org/courses/course-v1:MITx+grading-library+examples/)
-- is ready for the future of edX by being compatible with python 2 and 3
+- is ready for the future of edX by being compatible with Python 3.8 and 3.11
 - is actively maintained
Original file line number	Diff line number	Diff line change
Expand Up		@@ -120,4 +120,4 @@ We want to stress the simplicity of this example compared to implementing the sa

		## Note on Python Version

		Older versions of edX used python 2.7 in custom graders, while newer versions use python 3.5. The library works seamlessly with both versions, although some matrix math functionality requires python 3.5. The python version is automatically selected by the edX server. No changes to the XML code are required to work with either version of python.
		The Python version is automatically selected by the edX server. No changes to the XML code are required.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ Unfortunately, no. Those problem types cannot be used in a `customresponse` prob

		- Does the grader work with python 2 or python 3?

		It works with both! Older versions of edX ran python graders in python 2.7; newer versions use python 3.5. The library works seamlessly with both. No changes to any code are required to switch between versions. Some functionality requires python 3.5 however.
		It works with both! Older versions of edX ran python graders in python 2.7; newer versions use python 3.8. The library works seamlessly with both. No changes to any code are required to switch between versions. Some functionality requires python 3.5 however.