chore: Mark legacy code with YORE comments

Author: pawamoy

src/mkdocstrings_handlers/python/_internal/config.py

@@ -37,6 +37,7 @@
     if getattr(pydantic, "__version__", "1.").startswith("1."):
         raise ImportError  # noqa: TRY301
 
+    # YORE: EOL 3.9: Remove block.
     if sys.version_info < (3, 10):
         try:
             import eval_type_backport  # noqa: F401

src/mkdocstrings_handlers/python/_internal/handler.py

@@ -33,10 +33,10 @@
     from mkdocs.config.defaults import MkDocsConfig
 
 
+# YORE: EOL 3.10: Replace block with line 2.
 if sys.version_info >= (3, 11):
     from contextlib import chdir
 else:
-    # TODO: remove once support for Python 3.10 is dropped
     from contextlib import contextmanager
 
     @contextmanager
@@ -54,6 +54,7 @@ def chdir(path: str) -> Iterator[None]:
 patch_loggers(get_logger)
 
 
+# YORE: Bump 2: Remove block.
 def _warn_extra_options(names: Sequence[str]) -> None:
     warn(
         "Passing extra options directly under `options` is deprecated. "
@@ -94,14 +95,18 @@ def __init__(self, config: PythonConfig, base_dir: Path, **kwargs: Any) -> None:
         self.base_dir = base_dir
         """The base directory of the project."""
 
-        # YORE: Bump 2: Replace block with `self.global_options = config.options`.
+        # YORE: Bump 2: Remove block.
         global_extra, global_options = PythonOptions._extract_extra(config.options)
         if global_extra:
             _warn_extra_options(global_extra.keys())  # type: ignore[arg-type]
         self._global_extra = global_extra
         self.global_options = global_options
         """The global configuration options (in `mkdocs.yml`)."""
 
+        # YORE: Bump 2: Replace `# ` with `` within block.
+        # self.global_options = config.options
+        # """The global configuration options (in `mkdocs.yml`)."""
+
         # Warn if user overrides base templates.
         if self.custom_templates:
             for theme_dir in base_dir.joinpath(self.custom_templates, "python").iterdir():

src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -148,7 +148,7 @@ def do_format_signature(
         The same code, formatted.
     """
     env = context.environment
-    # TODO: Stop using `do_get_template` when `*.html` templates are removed.
+    # YORE: Bump 2: Replace `do_get_template(env, "signature")` with `"signature.html.jinja"`.
     template = env.get_template(do_get_template(env, "signature"))
 
     if annotations is None:
@@ -208,7 +208,7 @@ def do_format_attribute(
         The same code, formatted.
     """
     env = context.environment
-    # TODO: Stop using `do_get_template` when `*.html` templates are removed.
+    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"`.
     template = env.get_template(do_get_template(env, "expression"))
     annotations = context.parent["config"].show_signature_annotations
 
@@ -269,6 +269,7 @@ def do_order_members(
     return sorted(members, key=_order_map[order])
 
 
+# YORE: Bump 2: Remove block.
 @lru_cache
 def _warn_crossref() -> None:
     warnings.warn(
@@ -278,6 +279,7 @@ def _warn_crossref() -> None:
     )
 
 
+# YORE: Bump 2: Remove block.
 def do_crossref(path: str, *, brief: bool = True) -> Markup:
     """Deprecated. Filter to create cross-references.
 
@@ -298,6 +300,7 @@ def do_crossref(path: str, *, brief: bool = True) -> Markup:
     )
 
 
+# YORE: Bump 2: Remove block.
 @lru_cache
 def _warn_multi_crossref() -> None:
     warnings.warn(
@@ -307,6 +310,7 @@ def _warn_multi_crossref() -> None:
     )
 
 
+# YORE: Bump 2: Remove block.
 def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
     """Deprecated. Filter to create cross-references.
 
@@ -520,7 +524,10 @@ def formatter(code: str, line_length: int) -> str:
     return formatter
 
 
+# YORE: Bump 2: Remove line.
 @pass_environment
+# YORE: Bump 2: Replace `env: Environment, ` with `` within line.
+# YORE: Bump 2: Replace `str | ` with `` within line.
 def do_get_template(env: Environment, obj: str | Object) -> str | Template:
     """Get the template name used to render an object.
 
@@ -537,6 +544,7 @@ def do_get_template(env: Environment, obj: str | Object) -> str | Template:
         if name := extra_data.get("template", ""):
             return name
         name = obj.kind.value
+    # YORE: Bump 2: Replace block with `return f"{name}.html.jinja"`.
     try:
         template = env.get_template(f"{name}.html")
     except TemplateNotFound:

src/mkdocstrings_handlers/python/config.py

@@ -1,6 +1,6 @@
 """Deprecated. Import from `mkdocstrings_handlers.python` directly."""
 
-# YORE: Bump 1: Remove file.
+# YORE: Bump 2: Remove file.
 
 import warnings
 from typing import Any

src/mkdocstrings_handlers/python/handler.py

@@ -1,6 +1,6 @@
 """Deprecated. Import from `mkdocstrings_handlers.python` directly."""
 
-# YORE: Bump 1: Remove file.
+# YORE: Bump 2: Remove file.
 
 import warnings
 from typing import Any

src/mkdocstrings_handlers/python/rendering.py

@@ -1,6 +1,6 @@
 """Deprecated. Import from `mkdocstrings_handlers.python` directly."""
 
-# YORE: Bump 1: Remove file.
+# YORE: Bump 2: Remove file.
 
 import warnings
 from typing import Any

src/mkdocstrings_handlers/python/templates/material/_base/attribute.html

@@ -1,3 +1,4 @@
+{# YORE: Bump 2: Remove file. #}
 {% extends "_base/attribute.html.jinja" %}
 
 {% block logs scoped %}

src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -64,6 +64,7 @@ Context:
           This block renders the labels for the attribute.
           -#}
           {% with labels = attribute.labels %}
+            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
             {% include "labels"|get_template with context %}
           {% endwith %}
         {% endblock labels %}
@@ -110,6 +111,7 @@ Context:
           This block renders the docstring for the attribute.
           -#}
           {% with docstring_sections = attribute.docstring.parsed %}
+            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
             {% include "docstring"|get_template with context %}
           {% endwith %}
         {% endblock docstring %}

src/mkdocstrings_handlers/python/templates/material/_base/children.html

@@ -1,3 +1,4 @@
+{# YORE: Bump 2: Remove file. #}
 {% extends "_base/children.html.jinja" %}
 
 {% block logs scoped %}

src/mkdocstrings_handlers/python/templates/material/_base/class.html

@@ -1,3 +1,4 @@
+{# YORE: Bump 2: Remove file. #}
 {% extends "_base/class.html.jinja" %}
 
 {% block logs scoped %}