Move TODOs so they are easier to remove (frequenz-floss#120)

While updating project to new templates, it is much easier to be able to
remove whole lines than having to edit a line.

Author: llucax

RELEASE_NOTES.md

@@ -18,8 +18,13 @@
 
 ### Cookiecutter template
 
+
 - Generated project's dependencies were bumped.
 
+- Move `TODO`s so they are in their own line.
+
+  This makes it easier to upgrade projects to new templates, as removing whole lines is easier than having to edit them.
+
 ## Bug Fixes
 
 <!-- Here goes notable bug fixes that are worth a special mention or explanation -->

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

@@ -49,7 +49,8 @@ theme:
       name: Switch to light mode
 
 extra:
-  social:  # TODO(cookiecutter): You probably want to update the links
+  # TODO(cookiecutter): You probably want to update the social links
+  social:
   - icon: fontawesome/brands/github
     link: https://github.com/{{cookiecutter.github_org}}
   - icon: fontawesome/brands/linkedin

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

@@ -15,7 +15,8 @@ description = "{{cookiecutter.description}}"
 readme = "README.md"
 license = { text = "{{cookiecutter.license}}" }
 keywords = {{cookiecutter | keywords}}
-classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more classifiers if appropriate
+classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   {%- if cookiecutter.license == "MIT" %}
@@ -31,22 +32,23 @@ classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
+# TODO(cookiecutter): Remove and add more dependencies if appropriate
 {%- if cookiecutter.type in ("app", "actor", "model") %}
-dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+dependencies = [
   "typing-extensions == 4.5.0",
   # Make sure to update the mkdocs.yml file when
   # changing the version
   # (plugins.mkdocstrings.handlers.python.import)
   "frequenz-sdk == 0.24.0",
 ]
 {%- elif cookiecutter.type == "api" %}
-dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+dependencies = [
   "frequenz-api-common >= 0.3.1, < 0.4.0",
   "googleapis-common-protos >= 1.56.2, < 2",
   "grpcio >= 1.51.1, < 2",
 ]
 {%- else %}
-dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+dependencies = [
   "typing-extensions >= 4.5.0, < 5",
 ]
 {%- endif %}
@@ -56,7 +58,8 @@ dynamic = ["version"]
 name = "{{cookiecutter.author_name}}"
 email = "{{cookiecutter.author_email}}"
 
-[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
+[project.optional-dependencies]
 dev-docstrings = [
   "pydocstyle == 6.3.0",
   "darglint == 1.8.1",

tests_golden/integration/test_cookiecutter_generation/actor/cookiecutter-stdout.txt

@@ -8,11 +8,11 @@
 ./README.md:TODO(cookiecutter): Improve the README file
 ./mkdocs.yml:            # TODO(cookiecutter): You might want to add other external references here
 ./mkdocs.yml:  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
-./mkdocs.yml:  social:  # TODO(cookiecutter): You probably want to update the links
+./mkdocs.yml:  # TODO(cookiecutter): You probably want to update the social links
 ./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
-./pyproject.toml:[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 ./src/frequenz/actor/test/__init__.py:# TODO(cookiecutter): Remove this function
 ./src/frequenz/actor/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.
 ./tests/test_test.py:def test_test_fails() -> None:  # TODO(cookiecutter): Remove

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/mkdocs.yml

@@ -49,7 +49,8 @@ theme:
       name: Switch to light mode
 
 extra:
-  social:  # TODO(cookiecutter): You probably want to update the links
+  # TODO(cookiecutter): You probably want to update the social links
+  social:
   - icon: fontawesome/brands/github
     link: https://github.com/frequenz-floss
   - icon: fontawesome/brands/linkedin

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

@@ -15,7 +15,8 @@ description = "Test description"
 readme = "README.md"
 license = { text = "MIT" }
 keywords = ["frequenz", "python", "actor", "test"]
-classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more classifiers if appropriate
+classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: MIT License",
@@ -25,7 +26,8 @@ classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more dependencies if appropriate
+dependencies = [
   "typing-extensions == 4.5.0",
   # Make sure to update the mkdocs.yml file when
   # changing the version
@@ -38,7 +40,8 @@ dynamic = ["version"]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"
 
-[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
+[project.optional-dependencies]
 dev-docstrings = [
   "pydocstyle == 6.3.0",
   "darglint == 1.8.1",

tests_golden/integration/test_cookiecutter_generation/api/cookiecutter-stdout.txt

@@ -7,14 +7,14 @@
 ./README.md:TODO(cookiecutter): Improve the README file
 ./mkdocs.yml:            # TODO(cookiecutter): You might want to add other external references here
 ./mkdocs.yml:  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
-./mkdocs.yml:  social:  # TODO(cookiecutter): You probably want to update the links
+./mkdocs.yml:  # TODO(cookiecutter): You probably want to update the social links
 ./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
 ./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Add a more descriptive package description.
 ./proto/frequenz/api/test/test.proto:// TODO(cookiecutter): Remove this message.
 ./py/frequenz/api/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.
-./pyproject.toml:[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 
 --------------------------------------------------------------------------------
 

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/mkdocs.yml

@@ -49,7 +49,8 @@ theme:
       name: Switch to light mode
 
 extra:
-  social:  # TODO(cookiecutter): You probably want to update the links
+  # TODO(cookiecutter): You probably want to update the social links
+  social:
   - icon: fontawesome/brands/github
     link: https://github.com/frequenz-floss
   - icon: fontawesome/brands/linkedin

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

@@ -15,7 +15,8 @@ description = "Test description"
 readme = "README.md"
 license = { text = "MIT" }
 keywords = ["frequenz", "python", "api", "grpc", "protobuf", "rpc", "test"]
-classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more classifiers if appropriate
+classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: MIT License",
@@ -25,7 +26,8 @@ classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more dependencies if appropriate
+dependencies = [
   "frequenz-api-common >= 0.3.1, < 0.4.0",
   "googleapis-common-protos >= 1.56.2, < 2",
   "grpcio >= 1.51.1, < 2",
@@ -36,7 +38,8 @@ dynamic = ["version"]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"
 
-[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
+# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
+[project.optional-dependencies]
 dev-docstrings = [
   "pydocstyle == 6.3.0",
   "darglint == 1.8.1",

tests_golden/integration/test_cookiecutter_generation/app/cookiecutter-stdout.txt

@@ -7,11 +7,11 @@
 ./README.md:TODO(cookiecutter): Improve the README file
 ./mkdocs.yml:            # TODO(cookiecutter): You might want to add other external references here
 ./mkdocs.yml:  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
-./mkdocs.yml:  social:  # TODO(cookiecutter): You probably want to update the links
+./mkdocs.yml:  # TODO(cookiecutter): You probably want to update the social links
 ./mkdocs.yml:# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
-./pyproject.toml:[project.optional-dependencies] # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:classifiers = [ # TODO(cookiecutter): Remove and add more if appropriate
-./pyproject.toml:dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more classifiers if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more dependencies if appropriate
+./pyproject.toml:# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 ./src/frequenz/app/test/__init__.py:# TODO(cookiecutter): Remove this function
 ./src/frequenz/app/test/__init__.py:TODO(cookiecutter): Add a more descriptive module description.
 ./tests/test_test.py:def test_test_fails() -> None:  # TODO(cookiecutter): Remove