Fix cookiecutter TODOs

Signed-off-by: camille-bouvy-frequenz <[email protected]>

Author: camille-bouvy-frequenz

.github/ISSUE_TEMPLATE/bug.yml

@@ -11,8 +11,7 @@ labels:
 body:
   - type: markdown
     attributes:
-      value:
-        Thanks for taking the time to fill out this bug report!
+      value: Thanks for taking the time to fill out this bug report!
   - type: textarea
     id: what-happened
     attributes:
@@ -36,7 +35,7 @@ body:
       description:
         Please add a comma-separated list of the versions affected by this
         issue.
-      placeholder: 'Example: v0.11.0, v0.12.0'
+      placeholder: "Example: v0.11.0, v0.12.0"
   - type: dropdown
     id: part
     attributes:
@@ -50,9 +49,6 @@ body:
         - Documentation (part:docs)
         - Unit, integration and performance tests (part:tests)
         - Build script, CI, dependencies, etc. (part:tooling)
-        # TODO(cookiecutter): Add other parts
-        # Please have in mind that that the part:xxx labels need to
-        # be created in the GitHub repository.
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/config.yml

@@ -5,6 +5,4 @@ blank_issues_enabled: true
 contact_links:
   - name: Ask a question ❓
     url: https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/discussions/new?category=support
-    # TODO(cookiecutter): Make sure the GitHub repository has a discussion category "Support"
-    # Rename the "Q&A" category to "Support" and change the emoji to 🆘 (SOS)
     about: Use this if you are not sure how to do something, have installation problems, etc.

.github/keylabeler.yml

@@ -16,6 +16,3 @@ labelMappings:
   "part:tests": "part:tests"
   "part:tooling": "part:tooling"
   "part:❓": "part:❓"
-  # TODO(cookiecutter): Add other parts
-  # Please have in mind that that the part:xxx labels need to
-  # be created in the GitHub repository.

.github/workflows/release-notes-check.yml

@@ -12,7 +12,6 @@ on:
       - "labeled"
       - "unlabeled"
 
-
 jobs:
   check-release-notes:
     name: Check release notes are updated
@@ -22,8 +21,6 @@ jobs:
         if: github.event_name == 'pull_request'
         uses: brettcannon/check-for-changed-files@4170644959a21843b31f1181f2a1761d65ef4791 # v1.2.0
         with:
-          # TODO(cookiecutter): Uncomment the following line for private repositories, otherwise remove it and remove it
-          # token: ${{ secrets.github_token }}
           file-pattern: "RELEASE_NOTES.md"
           prereq-pattern: "src/**"
           skip-label: "cmd:skip-release-notes"

CODEOWNERS

@@ -4,5 +4,4 @@
 # Fallback owner.
 # These are the default owners for everything in the repo, unless a later match
 # takes precedence.
-# TODO(cookiecutter): Add more specific code-owners, check if the default is correct
 * @frequenz-floss/api-electricity-trading-team

README.md

@@ -8,8 +8,6 @@
 
 Electricity Trading API client for Python
 
-TODO(cookiecutter): Improve the README file
-
 ## Supported Platforms
 
 The following platforms are officially supported (tested):

docs/_scripts/macros.py

@@ -77,7 +77,5 @@ def define_env(env: macros.MacrosPlugin) -> None:
     # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
     env.variables["code_annotation_marker"] = _CODE_ANNOTATION_MARKER
 
-    # TODO(cookiecutter): Add any other macros, variables and filters here.
-
     # This hook needs to be done at the end of the `define_env` function.
     _hook_macros_plugin(env)

mkdocs.yml

@@ -8,15 +8,12 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
 copyright: "Copyright © 2024 Frequenz Energy-as-a-Service GmbH"
 repo_name: "frequenz-client-electricity-trading-python"
 repo_url: "https://github.com/frequenz-floss/frequenz-client-electricity-trading-python"
-# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
-# if the project uses a different default branch.
 edit_uri: "edit/main/docs/"
-strict: true  # Treat warnings as errors
+strict: true # Treat warnings as errors
 
 # Build directories
 theme:
   name: "material"
-  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
   logo: _img/logo.png
   favicon: _img/logo.png
   language: en
@@ -35,28 +32,27 @@ theme:
     - navigation.tracking
     - toc.follow
   palette:
-  - media: "(prefers-color-scheme: light)"
-    scheme: default
-    primary: indigo
-    accent: deep purple
-    toggle:
-      icon: material/weather-sunny
-      name: Switch to dark mode
-  - media: "(prefers-color-scheme: dark)"
-    scheme: slate
-    primary: black
-    accent: teal
-    toggle:
-      icon: material/weather-night
-      name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: deep purple
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: teal
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
 
 extra:
-  # 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
-    link: https://www.linkedin.com/company/frequenz-com
+    - icon: fontawesome/brands/github
+      link: https://github.com/frequenz-floss
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/frequenz-com
   version:
     provider: mike
     default: latest
@@ -116,10 +112,10 @@ plugins:
             show_source: true
             signature_crossrefs: true
           import:
-            # TODO(cookiecutter): You might want to add other external references here
-            # See https://mkdocstrings.github.io/python/usage/#import for details
             - https://docs.python.org/3/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
+            - https://frequenz-floss.github.io/frequenz-api-common/v0.3/objects.inv
+            - https://grpc.github.io/grpc/python/objects.inv
   # Note this plugin must be loaded after mkdocstrings to be able to use macros
   # inside docstrings. See the comment in `docs/_scripts/macros.py` for more
   # details

pyproject.toml

@@ -15,7 +15,6 @@ description = "Electricity Trading API client for Python"
 readme = "README.md"
 license = { text = "MIT" }
 keywords = ["frequenz", "python", "lib", "library", "client-electricity-trading", "client", "api", "python", "trading", "electricity-trading"]
-# TODO(cookiecutter): Remove and add more classifiers if appropriate
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",

src/frequenz/client/electricity_trading/__init__.py

@@ -1,25 +1,4 @@
 # License: MIT
 # Copyright © 2024 Frequenz Energy-as-a-Service GmbH
 
-"""Electricity Trading API client for Python.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
-
-
-# TODO(cookiecutter): Remove this function
-def delete_me(*, blow_up: bool = False) -> bool:
-    """Do stuff for demonstration purposes.
-
-    Args:
-        blow_up: If True, raise an exception.
-
-    Returns:
-        True if no exception was raised.
-
-    Raises:
-        RuntimeError: if blow_up is True.
-    """
-    if blow_up:
-        raise RuntimeError("This function should be removed!")
-    return True
+"""Electricity Trading API client for Python."""