From 5c3b93cf45d32f10952db97e7aadea7cd74fdcb8 Mon Sep 17 00:00:00 2001 From: apexdev Date: Wed, 29 May 2024 23:29:55 +0300 Subject: [PATCH 1/2] docs: Update test docstrings Patch docstrings with the following: - Fix grammar and typo errors. - Annotate `TODO` for consistency throughout project. [Note] TODOs in project adhere to the following style: `@TODO:` --- backend/test_flaskr.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/backend/test_flaskr.py b/backend/test_flaskr.py index 7a9b6b783..ea2ab7ac5 100644 --- a/backend/test_flaskr.py +++ b/backend/test_flaskr.py @@ -23,12 +23,12 @@ def setUp(self): def tearDown(self): - """Executed after reach test""" + """Executed after each test""" pass """ - TODO - Write at least one test for each test for successful operation and for expected errors. + @TODO: + Write at least one test for each endpoint for successful operation and for expected errors. """ From ee489f38fa81537247842e2a5ef7565944d8e2e6 Mon Sep 17 00:00:00 2001 From: apexdev Date: Wed, 29 May 2024 23:40:17 +0300 Subject: [PATCH 2/2] docs: Fix typos MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Patch `README` files by fixing typos to improve user experience. [Note] Py package `codespell` was used to find and fix typos in the repo. [Commands] ➜ codespell . ➜ codespell -i 3 -w [Docs] See: https://github.com/codespell-project/codespell --- backend/README.md | 2 +- frontend/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/backend/README.md b/backend/README.md index d5318811d..852b785c7 100644 --- a/backend/README.md +++ b/backend/README.md @@ -6,7 +6,7 @@ 1. **Python 3.7** - Follow instructions to install the latest version of python for your platform in the [python docs](https://docs.python.org/3/using/unix.html#getting-and-installing-the-latest-version-of-python) -2. **Virtual Environment** - We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organized. Instructions for setting up a virual environment for your platform can be found in the [python docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) +2. **Virtual Environment** - We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organized. Instructions for setting up a virtual environment for your platform can be found in the [python docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) 3. **PIP Dependencies** - Once your virtual environment is setup and running, install the required dependencies by navigating to the `/backend` directory and running: diff --git a/frontend/README.md b/frontend/README.md index a3aa782d1..94b4a7c3c 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -120,7 +120,7 @@ You can optionally update this game play to increase the number of questions or `GET '/categories/${id}/questions'` -- Fetches questions for a cateogry specified by id request argument +- Fetches questions for a category specified by id request argument - Request Arguments: `id` - integer - Returns: An object with questions for the specified category, total questions, and current category string