Minor fixes and improvements (#81)

- Add more cross-reference object inventories
- Fix typo in comments
- Run isort in benchmarks too
- Disable pylint `unsubscriptable-object` check

Author: llucax

.github/workflows/ci.yaml

@@ -50,7 +50,7 @@ jobs:
           python -m pip install -e .[dev-noxfile]
 
       - name: Run nox
-        # To speed things up a bit we use the speciall ci_checks_max session
+        # To speed things up a bit we use the special ci_checks_max session
         # that uses the same venv to run multiple linting sessions
         run: nox -e ci_checks_max pytest_min
         timeout-minutes: 60

cookiecutter/{{cookiecutter.github_repo_name}}/.github/workflows/ci.yaml

@@ -50,7 +50,7 @@ jobs:
           python -m pip install -e .[dev-noxfile]
 
       - name: Run nox
-        # To speed things up a bit we use the speciall ci_checks_max session
+        # To speed things up a bit we use the special ci_checks_max session
         # that uses the same venv to run multiple linting sessions
         run: nox -e ci_checks_max pytest_min
         timeout-minutes: 10

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

@@ -109,6 +109,12 @@ plugins:
             # 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
+{%- if cookiecutter.type in ("actor", "app", "model") %}
+            - https://frequenz-floss.github.io/frequenz-channels-python/v0.14/objects.inv
+            - https://frequenz-floss.github.io/frequenz-sdk-python/v0.20/objects.inv
+{%- elif cookiecutter.type == "api" %}
+            - https://grpc.github.io/grpc/python/objects.inv
+{%- endif %}
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   - search
   - section-index

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

@@ -34,6 +34,9 @@ requires-python = ">= 3.11, < 4"
 {%- if cookiecutter.type in ("app", "actor", "model") %}
 dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
   "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.20.0",
 ]
 {%- elif cookiecutter.type == "api" %}
@@ -114,7 +117,7 @@ include = '\.pyi?$'
 profile = "black"
 line_length = 88
 {#- We don't include "py" here for API because we don't want to check generated files #}
-src_paths = ["src", "examples", "tests"]
+src_paths = ["benchmarks", "examples", "src", "tests"]
 
 [tool.pylint.similarities]
 ignore-comments = ['yes']
@@ -128,6 +131,9 @@ disable = [
   # disabled because it conflicts with isort
   "wrong-import-order",
   "ungrouped-imports",
+  # pylint's unsubscriptable check is buggy and is not needed because
+  # it is a type-check, for which we already have mypy.
+  "unsubscriptable-object",
 ]
 
 [tool.pytest.ini_options]

pyproject.toml

@@ -118,6 +118,9 @@ disable = [
   # disabled because it conflicts with isort
   "wrong-import-order",
   "ungrouped-imports",
+  # pylint's unsubscriptable check is buggy and is not needed because
+  # it is a type-check, for which we already have mypy.
+  "unsubscriptable-object",
 ]
 
 [[tool.mypy.overrides]]