From 93e68b698a1e4f94944de4db0f145eef475e7172 Mon Sep 17 00:00:00 2001 From: Pedram Navid <1045990+PedramNavid@users.noreply.github.com> Date: Sat, 10 Aug 2024 15:43:07 -0700 Subject: [PATCH] improve docstring error handling --- docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/__init__.py b/docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/__init__.py index 9ca64707bb617..242b77048a788 100644 --- a/docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/__init__.py +++ b/docs/sphinx/_ext/dagster-sphinx/dagster_sphinx/__init__.py @@ -75,7 +75,7 @@ def record_error(env: BuildEnvironment, message: str) -> None: def check_public_method_has_docstring(env: BuildEnvironment, name: str, obj: object) -> None: if name != "__init__" and not obj.__doc__: message = ( - f"Docstring not found for {obj}.{name}. " + f"Docstring not found for {obj.__repr__()}.{name}. " "All public methods and properties must have docstrings." ) record_error(env, message)