From f0c3141690266dc1e9261e82e9f7b404eebd7e6e Mon Sep 17 00:00:00 2001 From: Emad Rad Date: Sat, 25 May 2024 12:06:01 +0330 Subject: [PATCH] chore: typos fixed --- cookiecutter-django-ida/hooks/post_gen_project.py | 2 +- docs/decisions/0003-layered-cookiecutter.rst | 6 +++--- docs/decisions/0004-which-cookiecutters-included.rst | 6 +++--- .../test_utils/__init__.py | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cookiecutter-django-ida/hooks/post_gen_project.py b/cookiecutter-django-ida/hooks/post_gen_project.py index bd4e99c9..4280c615 100644 --- a/cookiecutter-django-ida/hooks/post_gen_project.py +++ b/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") diff --git a/docs/decisions/0003-layered-cookiecutter.rst b/docs/decisions/0003-layered-cookiecutter.rst index 7abf1d00..5d845aa0 100644 --- a/docs/decisions/0003-layered-cookiecutter.rst +++ b/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,8 +62,8 @@ 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. diff --git a/docs/decisions/0004-which-cookiecutters-included.rst b/docs/decisions/0004-which-cookiecutters-included.rst index e7a8c6dc..37c92f80 100644 --- a/docs/decisions/0004-which-cookiecutters-included.rst +++ b/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. diff --git a/python-template/{{cookiecutter.placeholder_repo_name}}/test_utils/__init__.py b/python-template/{{cookiecutter.placeholder_repo_name}}/test_utils/__init__.py index 7961e470..94666f1c 100644 --- a/python-template/{{cookiecutter.placeholder_repo_name}}/test_utils/__init__.py +++ b/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).