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

pydoc rendering on datatip at ide-python with atom-ide-ui #291

Open
dwSun opened this issue Mar 21, 2018 · 1 comment
Open

pydoc rendering on datatip at ide-python with atom-ide-ui #291

dwSun opened this issue Mar 21, 2018 · 1 comment

Comments

@dwSun
Copy link

dwSun commented Mar 21, 2018

37638320-2d413d24-2c47-11e8-8405-74d4654665c8

It looks that the pydoc was rendered as markdown.
Can you fix it?

Owner of ide-python said:

I'm afraid this requires some upstream fixes in either the python language server or the protocol specifications.
The problem is that the LSP currently only supports markdown or plain text. Since Python docstrings are usually written in rst the language server would need to convert it to markdown first. Ideally this could also be handled by the frontend but this also requires (small) changes to the protocol itself.

Also, here are issues related to this problem:
atom-community/ide-python#95
facebookarchive/atom-ide-ui#23

@damieng
Copy link

damieng commented Mar 21, 2018

def format_docstring(contents):
would need to be improved to spot and correctly encode the right patterns. Would need to know what the various formats can look like.

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

No branches or pull requests

2 participants