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.

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

Conversation

krassowski
Copy link
Contributor

Migrate from deprecated MarkedString to MarkupContent (fixes #21) and convert documentation strings to Markdown using docstring_to_markdown fixes #22, and supersedes #36.

Clients can now choose whether they prefer to receive plaintext or markdown markup by specifying:

  • HoverClientCapabilities.contentFormat for hover,
  • SignatureHelpClientCapabilities.documentationFormat for signature, or
  • CompletionClientCapabilities.completionItem.documentationFormat for completions

and the client preference will be respected.

@krassowski
Copy link
Contributor Author

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).

@ccordoba12
Copy link
Member

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.

@krassowski
Copy link
Contributor Author

Done: https://github.com/python-lsp/docstring-to-markdown.

@cazador481
Copy link

It has been a while since this has been touched, is there any plans to release these changes?

@krassowski
Copy link
Contributor Author

To celebrate one year anniversary of this pull request I resolved the merge conflicts 🎉. And all checks are still passing 💚.

Copy link
Member

@ccordoba12 ccordoba12 left a 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!

pylsp/_utils.py Show resolved Hide resolved
pylsp/_utils.py Outdated Show resolved Hide resolved
Copy link
Member

@ccordoba12 ccordoba12 left a 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.

pylsp/_utils.py Outdated Show resolved Hide resolved
pylsp/_utils.py Show resolved Hide resolved
Copy link
Member

@ccordoba12 ccordoba12 left a 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!

@ccordoba12 ccordoba12 merged commit 449d11a into python-lsp:develop Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants