From 3a54f499e4a69d0fc1d8f0dc72e4f6fe43207193 Mon Sep 17 00:00:00 2001 From: mushitoriami Date: Mon, 22 Jun 2026 21:33:46 +0900 Subject: [PATCH 1/3] docs: Fix google-style docstrings in `duties.py` --- duties.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/duties.py b/duties.py index 965960a9..02f4dab8 100644 --- a/duties.py +++ b/duties.py @@ -128,7 +128,7 @@ def check_quality(ctx: Context) -> None: ...where ID is the identifier of the rule you want to ignore for this line. - Example: + Examples: ```python title="src/your_package/module.py" import subprocess ``` @@ -220,7 +220,7 @@ def check_types(ctx: Context) -> None: ...where ID is the name of the warning. - Example: + Examples: ```python title="src/your_package/module.py" result = data_dict.get(key, None).value ``` From ca7ab2c8726d8730786567c37cccd7a215164da3 Mon Sep 17 00:00:00 2001 From: mushitoriami Date: Tue, 23 Jun 2026 11:03:53 +0900 Subject: [PATCH 2/3] Revert "docs: Fix google-style docstrings in `duties.py`" This reverts commit 3a54f499e4a69d0fc1d8f0dc72e4f6fe43207193. --- duties.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/duties.py b/duties.py index 02f4dab8..965960a9 100644 --- a/duties.py +++ b/duties.py @@ -128,7 +128,7 @@ def check_quality(ctx: Context) -> None: ...where ID is the identifier of the rule you want to ignore for this line. - Examples: + Example: ```python title="src/your_package/module.py" import subprocess ``` @@ -220,7 +220,7 @@ def check_types(ctx: Context) -> None: ...where ID is the name of the warning. - Examples: + Example: ```python title="src/your_package/module.py" result = data_dict.get(key, None).value ``` From 1028bf6aae7cfff5b8d5c1e46ec282eb6c24037c Mon Sep 17 00:00:00 2001 From: mushitoriami Date: Tue, 23 Jun 2026 11:04:55 +0900 Subject: [PATCH 3/3] Set `doc_style` option to `google` to fix admonition rendering --- mkdocs.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index d96eea3e..a78bd739 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -222,10 +222,8 @@ plugins: options: backlinks: tree docstring_options: - per_style_options: - google: - ignore_init_summary: true - docstring_style: auto + ignore_init_summary: true + docstring_style: google docstring_section_style: list extensions: - griffe_inherited_docstrings