-
Notifications
You must be signed in to change notification settings - Fork 204
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
Migrate to MarkupContent and convert docstrings to Markdown #80
Migrate to MarkupContent and convert docstrings to Markdown #80
Conversation
I am also happy to transfer https://github.com/krassowski/docstring-to-markdown to python-lsp organization if you agree (I will obviously continue to maintain it and address any issues). |
Sounds good to me. |
It has been a while since this has been touched, is there any plans to release these changes? |
To celebrate one year anniversary of this pull request I resolved the merge conflicts 🎉. And all checks are still passing 💚. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks pretty good to me, thanks @krassowski!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@krassowski, last comments for you then this should be ready.
Co-authored-by: Carlos Cordoba <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me now, thanks @krassowski!
Migrate from deprecated
MarkedString
toMarkupContent
(fixes #21) and convert documentation strings to Markdown usingdocstring_to_markdown
fixes #22, and supersedes #36.Clients can now choose whether they prefer to receive
plaintext
ormarkdown
markup by specifying:HoverClientCapabilities.contentFormat
for hover,SignatureHelpClientCapabilities.documentationFormat
for signature, orCompletionClientCapabilities.completionItem.documentationFormat
for completionsand the client preference will be respected.