Skip to content

Add support for help_text field parameter as docstring for django model fields.#129

Merged
pawamoy merged 4 commits intomkdocstrings:masterfrom
mabugaj:master
Dec 18, 2021
Merged

Add support for help_text field parameter as docstring for django model fields.#129
pawamoy merged 4 commits intomkdocstrings:masterfrom
mabugaj:master

Conversation

@mabugaj
Copy link
Contributor

@mabugaj mabugaj commented Dec 16, 2021

Here are added features:

  • support for help_text parameter of django model field
  • casting docstring to string type, which solves the problem of serializing Proxy objects in case of lazy translation

This is the final result with and without help_text:

image

this closes #127

mabugaj and others added 2 commits December 17, 2021 23:48
Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, good to go!

@pawamoy pawamoy merged commit 01ac524 into mkdocstrings:master Dec 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add support for help_text field parameter as description with django model fields.

2 participants