Skip to content
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.

Sign up for GitHub

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

cleanup description #2

Merged
merged 1 commit into from
Dec 17, 2023
Merged

cleanup description #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/griffe_fieldz/_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from __future__ import annotations

import inspect
import textwrap
from operator import ge
from typing import TYPE_CHECKING, Any, Iterable, Sequence

Expand Down Expand Up @@ -119,10 +120,11 @@ def _fields_to_params(
params: list[DocstringParameter] = []
attrs: list[DocstringAttribute] = []
for field in fields:
description = field.description or field.metadata.get("description", "")
kwargs: dict = {
"name": field.name,
"annotation": _to_annotation(field.type, docstring),
"description": field.description or field.metadata.get("description", ""),
"description": textwrap.dedent(description).strip(),
"value": _default_repr(field),
}
if field.init:
Expand Down
Loading