-
-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
bug: Extension does not work when separate_signature
is set to True [mkdocs]
#9
Comments
Hi @mmzeynalli, thank you for the report. Could you actually provide some code that would allow me to replicate the issue you describe? |
So, my Pydantic schemas is simple: from urllib.parse import parse_qsl
from pydantic import BaseModel, model_validator
class CallbackDataSchema(BaseModel):
"""Raw və encoded callback data schema-sı"""
data: str
"""Base64 formatında gələn data"""
signature: str
"""EPOINT_PRIVATE_KEY"""
@model_validator(mode='before')
@classmethod
def convert_str_to_dict(cls, data: bytes) -> dict:
"""Query string formatında gələn datanı düzgün formata çevirmək üçün funksiya"""
return dict(parse_qsl(data.decode())) I have provided my |
…ures in headings Issue-griffe-pydantic#9: mkdocstrings/griffe-pydantic#9
OK it was actually that mkdocstrings-python did not respect the |
…ures in headings Issue-griffe-pydantic#9: mkdocstrings/griffe-pydantic#9
Description of the bug
So, I had my docs already working. Added new pydantic models and saw that mkdocstrings cannot parse it correctly so I used this extension, but got really similar result.
To Reproduce
My config file:
Full traceback
Full traceback
Current behavior
The docstrings of fields are shown okay, however, it does not show the types of fields.
Expected behavior
If I comment out
separate_signature: true
, then everything is as expected:Environment information
- __System__: Linux-6.8.0-1014-oem-x86_64-with-glibc2.39 - __Python__: cpython 3.12.3 - __Environment variables__: - __Installed packages__: - `griffe-pydantic` v1.0.0
Additional context
The text was updated successfully, but these errors were encountered: