Merge pull request #53 from UBC-MDS/fix/feedback-address

Fix/feedback address
UBC-MDS · Feb 4, 2025 · ceddab8 · ceddab8
2 parents a5524f8 + dd11b52
commit ceddab8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -73,7 +73,15 @@ from pysorting import quick_sort, bubble_sort, shell_sort, insertion_sort
 bubble_sort([4, 2, 7, 1, 3], ascending = False)
 ```
 
-For more examples on usage of the different functions,you can check out this [Example NoteBook](https://pysorting.readthedocs.io/en/latest/example.html)
+For more examples on usage of the different functions, you can check out this [Example NoteBook](https://pysorting.readthedocs.io/en/latest/example.html)
+
+## Running Tests
+
+To run tests and check code coverage, use the following command in the project root:
+
+```bash
+poetry run pytest --cov=pysorting
+```
 
 ## Contributing
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,7 @@
 name = "pysorting"
 version = "0.0.4"
 description = "a package to aid user in implementing various sorting algorithms"
-authors = ["Group 27"]
+authors = ["Chukwunonso Ebele-muolokwu", "Marek Boulerice", "Shashank Hosahalli Shivamurthy", "Siddarth Subrahmanian"]
 license = "MIT"
 readme = "README.md"