OPT: improve the docs

kpn · May 26, 2023 · 178fc80 · 178fc80
1 parent 1d53960
commit 178fc80
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 14 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -38,7 +38,7 @@ jobs:
       - name: "📥 Install Material for MkDocs"
         run: |
           python -m venv .venv
-          .venv/bin/pip install --upgrade 'mkdocs-material~=9.0' 'mkdocs-autorefs~=0.4' 'mkdocstrings[python]~=0.20' 'mkdocs-git-revision-date-localized-plugin~=1.1' pillow cairosvg 'black~=22.12'
+          .venv/bin/pip install --upgrade 'mkdocs-material>=9.0.0,<10.0.0' 'mkdocs-autorefs>=0.4.1,<1.0.0' 'mkdocstrings[python]>=0.20.0,<1.0.0' 'mkdocs-git-revision-date-localized-plugin>=1.1.0,<2.0.0' pillow cairosvg 'black>=22.12.0,<23.0.0'
 
       - run: ".venv/bin/mkdocs build --site-dir _site"
         name: "📦 Build"

diff --git a/docs/getting-started/handling-errors.md b/docs/getting-started/handling-errors.md
@@ -25,6 +25,7 @@ However, Combadge provides some base response classes, which come in handy:
 ::: combadge.core.response.ErrorResponse
     options:
       heading_level: 3
+      members: ["Error", "raise_for_result", "unwrap"]
 
 !!! tip "Discriminated unions"
 

diff --git a/poetry.lock b/poetry.lock