chore: cleanup

- minor typos fixed
- code highlighting added for better readability.
- `.md` warnings fixed

README.rst

@@ -26,7 +26,7 @@ Using the cookiecutters
 
 1. One Time Setup
 =================
-.. code-block::
+.. code-block:: bash
 
   # Clone the repository
   git clone [email protected]:openedx/edx-cookiecutters.git
@@ -40,7 +40,7 @@ Using the cookiecutters
 
 These instructions assume you have cloned this repository and are currently in its head dir. You will need a virtualenv for running the cookiecutter. You can discard it once the cookiecutter has made your new repo.
 
-Commands::
+.. code-block:: bash
 
     $ make requirements  # from inside edx-cookiecutter repo
     # Replace <OUTPUT-DIRECTORY> with the base directory; your new directory will go inside.
@@ -50,24 +50,26 @@ Commands::
 3. TODOs after running cookiecutter
 ===================================
 
-- Modify project README
-- Modify the "requirements upgrade workflow" at ".github/workflows/upgrade-python-requirements.yml" and add "team_reviewers" and the "email_address" of the team/person
-- Modify project docs/decisions/0001-purpose-of-this-repo.rst ADR
-- Commit and push to GitHub
-- On GitHub, update repo's "About" description
+- Modify project ``README``.
+- Modify the ``requirements upgrade workflow`` at ``.github/workflows/upgrade-python-requirements.yml`` and add ``team_reviewers`` and the ``email_address`` of the team/person.
+- Modify project ``docs/decisions/0001-purpose-of-this-repo.rst`` ADR.
+- Commit and push to GitHub.
+- On GitHub, update repo's ``About`` description.
 
 Updating cookiecutters
 **********************
 
 If you find anything that is outdated in the cookiecutters in this repository, please create a PR with updates.
 
 
-.. Note:: Some of the cookiecutters in this repository use the layered cookiecutter approach. If you are modifying these, please see "Local Debugging of the layered cookiecutters" section below.
+.. Note::
+
+    Some of the cookiecutters in this repository use the layered cookiecutter approach. If you are modifying these, please see "Local Debugging of the layered cookiecutters" section below.
 
 
 Directions for contributing to this repository
 ==============================================
-.. code-block::
+.. code-block:: bash
 
   # Clone the repository
   git clone [email protected]:openedx/edx-cookiecutters.git
@@ -151,7 +153,7 @@ Contributions are very welcome. Tests can be run with `tox`_. Please ensure the
 License
 =======
 
-The code in this repository is licensed under the Apache Software License 2.0 unless
+The code in this repository is licensed under the ``Apache Software License 2.0`` unless
 otherwise noted.
 
 Please see ``LICENSE.txt`` for details.

cookiecutter-django-app/{{cookiecutter.repo_name}}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,7 @@
 
 **Merge checklist:**
 Check off if complete *or* not applicable:
+
 - [ ] Version bumped
 - [ ] Changelog record added
 - [ ] Documentation updated (not only docstrings)

cookiecutter-django-ida/hooks/post_gen_project.py

@@ -23,6 +23,6 @@
     }
 )
 
-# Removing unecessary files from python and django templates:
+# Removing unnecessary files from python and django templates:
 os.remove("setup.py")
 os.remove("MANIFEST.in")

cookiecutter-django-ida/{{cookiecutter.repo_name}}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,14 @@
 
 **Merge checklist:**
+
 Check off if complete *or* not applicable:
+
 - [ ] Documentation updated (not only docstrings)
 - [ ] Fixup commits are squashed away
 - [ ] Unit tests added/updated
 - [ ] Manual testing instructions provided
 - [ ] Noted any: Concerns, dependencies, migration issues, deadlines, tickets
 
 **Post-merge:**
+
 - [ ] [Backported](https://openedx.atlassian.net/wiki/spaces/COMM/pages/2065367719/Making+a+pull+request+for+a+named+release) to latest and next named releases

docs/decisions/0003-layered-cookiecutter.rst

@@ -15,7 +15,7 @@ Context
 Decision
 ********
 
-We will layer cookiecutters in order to share boilerpate code. This approach requires two categories of cookiecutters:
+We will layer cookiecutters in order to share boilerplate code. This approach requires two categories of cookiecutters:
 
 * *template-only*: These cookiecutters contain files used as boilerplate across other cookiecutters, but do not result in a workable repository output.
 * *final-output*: These cookiecutters produce the final output, resulting in a working directory.
@@ -62,7 +62,7 @@ Additionally, the decision to not allow partial file overwrites should help some
 Rejected Alternatives
 *********************
 
-No sharing of boilerpate code
+No sharing of boilerplate code
 =============================
 
 As noted in the `Context`_, we had a maintenance problem when not sharing boilerplate code. It remains to be seen if the potential drawbacks of this approach will outweigh the drawbacks of the original maintenance problem.

docs/decisions/0004-which-cookiecutters-included.rst

@@ -24,7 +24,7 @@ Decision
 
 edx-cookiecutter should be the central point for public edx cookiecutters. Most Open edx public cookiecutters should be placed in this repository.
 
-If there is a complelling case why a cookiecutter should be elsewhere, a link to it should be added the edx-cookiecutter/README.rst.
+If there is a compelling case why a cookiecutter should be elsewhere, a link to it should be added the edx-cookiecutter/README.rst.
 
 
 Consequences
@@ -35,7 +35,7 @@ All edx cookiecutters should be moved to this repository.
 Rejected Alternatives
 *********************
 
-Seperate Repos for frontend and backend cookiecutters
+Separate Repos for frontend and backend cookiecutters
 =====================================================
 
-Rejected because of the very real possiblity of creating a cookiecutter that deals with both frontend and backend.
+Rejected because of the very real possibility of creating a cookiecutter that deals with both frontend and backend.

python-template/cookiecutter.json

@@ -9,18 +9,9 @@
   "author_email": "[email protected]",
   "open_source_license": ["AGPL 3.0", "Apache Software License 2.0", "Not open source"],
   "setup_py_keyword_args": "None",
-  "setup_py_loading_pkg_data": [
-    "no",
-    "yes"
-  ],
-  "requires_django": [
-    "no",
-    "yes"
-  ],
-  "if_features_docs": [
-    "no",
-    "yes"
-  ],
+  "setup_py_loading_pkg_data": ["no", "yes"],
+  "requires_django": ["no", "yes"],
+  "if_features_docs": ["no", "yes"],
   "placeholder_repo_name": "placeholder_repo_name",
   "_copy_without_render": [".github/workflows/*.yml"],
   "__prompts__": {

python-template/{{cookiecutter.placeholder_repo_name}}/test_utils/__init__.py

@@ -1,7 +1,7 @@
 """
 Test utilities.
 
-Since pytest discourages putting __init__.py into testdirectory
+Since pytest discourages putting __init__.py into test directory
 (i.e. making tests a package) one cannot import from anywhere
 under tests folder. However, some utility classes/methods might be useful
 in multiple test modules (i.e. factoryboy factories, base test classes).