From 0ac47a566456d518269025dc28af3978358c9cac Mon Sep 17 00:00:00 2001 From: Kohei Shinohara Date: Sun, 7 Jan 2024 13:59:36 +0900 Subject: [PATCH] Fix type in quick-start example --- docs/quickstart.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index a993976..c3d9775 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -103,12 +103,12 @@ but the external project exposes it only as `package.module.MyClass`. In this case, you can use the {confval}`autodoc2_replace_annotations` and {confval}`autodoc2_replace_bases` configuration options to replace the annotation/class base with the correct reference. ```python -autodoc2_replace_annotations = { - "package.MyClass": "package.module.MyClass", -} -autodoc2_replace_bases = { - "package.MyClass": "package.module.MyClass", -} +autodoc2_replace_annotations = [ + ("package.MyClass", "package.module.MyClass"), +] +autodoc2_replace_bases = [ + ("package.MyClass", "package.module.MyClass"), +] ``` If you cannot, or do not, wish to fix them,