Skip to content

Commit 1e11801

Browse files
committed
feat: Implement no-op
1 parent c4409f0 commit 1e11801

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

src/mkdocstrings_handlers/csharp/handler.py

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44

55
from typing import TYPE_CHECKING, Any, ClassVar
66

7-
from mkdocs.exceptions import PluginError
8-
from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem
7+
from mkdocstrings.handlers.base import BaseHandler, CollectorItem
98
from mkdocstrings.loggers import get_logger
109

1110
if TYPE_CHECKING:
@@ -65,7 +64,7 @@ def collect(self, identifier: str, config: MutableMapping[str, Any]) -> Collecto
6564
Returns:
6665
Anything you want, as long as you can feed it to the `render` method.
6766
"""
68-
raise CollectionError("Implement me!")
67+
return {"identifier": identifier}
6968

7069
def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa: ARG002
7170
"""Render a template using provided data and configuration options.
@@ -78,13 +77,10 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa
7877
Returns:
7978
The rendered template as HTML.
8079
"""
81-
# final_config = {**self.default_config, **config}
82-
# heading_level = final_config["heading_level"]
83-
# template = self.env.get_template(f"{data...}.html.jinja")
84-
# return template.render(
85-
# **{"config": final_config, data...: data, "heading_level": heading_level, "root": True},
86-
# )
87-
raise PluginError("Implement me!")
80+
return (
81+
f"<i><b><code>::: {data['identifier']}</code></b><br>The public version of mkdocstrings-csharp is a no-op "
82+
"and exist only to allow building docs without errors. Please rely on docs preview in CI.</i>"
83+
)
8884

8985
def update_env(self, md: Markdown, config: dict) -> None:
9086
"""Update the Jinja environment with any custom settings/filters/options for this handler.

0 commit comments

Comments
 (0)