Merge pull request #474 from CodeWithEmad/chore/cleanup

chore: cleanup
openedx · Nov 7, 2024 · 90ca184 · 90ca184
2 parents 26118b9 + 84c9a15
commit 90ca184
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 9 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -22,25 +22,29 @@ Change Log
 
 Changed
 =======
-- added new catalog-info field ``openedx.org/release``
-- removed openedx.yaml file
+
+- Added new catalog-info field ``openedx.org/release``
+- Removed ``openedx.yaml`` file
 
 2023-12-18
 **********
 
 Added
 =======
+
 - Added python3.11 support.
 
 Changed
 =======
+
 - Add selfcheck target to Makefile
 
 2023-12-15
 **********
 
 Changed
 =======
+
 - Remove incorrect build step from xblock ci template
 - Fix docstrings
 - Add a unit test so coverage can run
@@ -50,6 +54,7 @@ Changed
 
 Changed
 =======
+
 - Remove pii_check from xblock cookiecutter
 
 2023-12-06
@@ -95,7 +100,7 @@ Added
 Changed
 =======
 
-- In setup.py, support advertising constraints on packages with multiple extras
+- In ``setup.py``, support advertising constraints on packages with multiple extras
 - Fail packaging if requirements are named differently in different places or have different extras listed
 
 2023-08-11
@@ -229,9 +234,9 @@ Fixed
 Changed
 =======
 
-- Updated upgrade-python-requirements.yml GitHub Action to latest from `upgrade-python-requirements.yml template`_.
-- Remove deprecated codecov CI package in requirements/ci.in
-- Added linebreaks to root urls.py docstring for cookiecutter-django-ida to squash Sphinx error.
+- Updated ``upgrade-python-requirements.yml`` GitHub Action to latest from `upgrade-python-requirements.yml template`_.
+- Remove deprecated codecov CI package in ``requirements/ci.in``
+- Added line breaks to root ``urls.py`` docstring for ``cookiecutter-django-ida`` to squash Sphinx error.
 - Fixed cookiecutter-django-ida .coveragerc file so it references project_name, not source_name.
 - Fixed .github/workflow/ci.yml so it uploads coverage reports in the tox env that the coverage files are generated in.
 
@@ -304,7 +309,7 @@ Removed
 Fixed
 =====
 
-- Fix or remove ``tags`` repo metadata in several templates; remove deprecated ``nick`` from openedx.yaml (see OEP-2)
+- Fix or remove ``tags`` repo metadata in several templates; remove deprecated ``nick`` from ``openedx.yaml`` (see OEP-2)
 - Remove extraneous period after short description
 - Move short description to top of readme
 - Use project name, not repo name, for package name in setup.py

diff --git a/cookiecutter-python-library/README.rst b/cookiecutter-python-library/README.rst
@@ -7,7 +7,7 @@ A cookiecutter_ template for edX python projects. For django-related cookiecutte
 
 **This template produces a Python 3.12 project.**
 
-This cookiecutter template is intended for new edX python libraries.
+This cookiecutter template is intended for new Open edX python libraries.
 
 Usage
 *****

diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/base.in
@@ -1,7 +1,9 @@
 # Core requirements for using this application
+
 -c constraints.txt
 
 django-statici18n
 edx-i18n-tools
 Mako
-XBlock 
+XBlock
+xblock-utils
diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/dev.in
@@ -1,4 +1,5 @@
 # Additional requirements for development of this application
+
 -c constraints.txt
 
 -r pip-tools.txt          # pip-tools and its dependencies, for managing requirements files

diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/pip.in
@@ -1,4 +1,5 @@
 # Core dependencies for installing other packages
+
 -c constraints.txt
 
 pip

diff --git a/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in b/cookiecutter-xblock/{{cookiecutter.repo_name}}/requirements/test.in
@@ -1,4 +1,5 @@
 # Requirements for test runs.
+
 -c constraints.txt
 
 -r base.txt               # Core dependencies for this package

diff --git a/requirements/base.in b/requirements/base.in
@@ -1,4 +1,5 @@
 # Core requirements for using this package template
+
 -c constraints.txt
 
 cookiecutter              # Utility to generate a package from this template

diff --git a/requirements/ci.in b/requirements/ci.in
@@ -1,4 +1,5 @@
 # Requirements for running tests on CI
+
 -c constraints.txt
 
 tox                       # Virtualenv management for tests
diff --git a/requirements/dev.in b/requirements/dev.in
@@ -1,4 +1,5 @@
 # Additional requirements for development of this template
+
 -c constraints.txt
 
 -r pip-tools.txt          # pip-tools and its dependencies, for managing requirements files

diff --git a/requirements/pip-tools.in b/requirements/pip-tools.in
@@ -1,4 +1,5 @@
 # Just the dependencies to run pip-tools, mainly for the "upgrade" make target
+
 -c constraints.txt
 
 pip-tools                 # Contains pip-compile, used to generate pip requirements files
diff --git a/requirements/pip.in b/requirements/pip.in
@@ -1,4 +1,5 @@
 # Core dependencies for installing other packages
+
 -c constraints.txt
 
 pip

diff --git a/requirements/test.in b/requirements/test.in
@@ -1,4 +1,5 @@
 # Requirements for test runs
+
 -c constraints.txt
 
 -r base.txt               # Core dependencies for the cookiecutter
-Original file line number
+Diff line change
@@ Expand Up @@
     **This template produces a Python 3.12 project.**
-    This cookiecutter template is intended for new edX python libraries.
+    This cookiecutter template is intended for new Open edX python libraries.
     Usage
     *****
@@ Expand Down @@