-
Notifications
You must be signed in to change notification settings - Fork 284
Separate signature from docstring on hover #623
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
Conversation
@andfoy, please take a look at this one. |
I think we should aim to support Markdown fully using |
@andfoy Well, that pr implements rst2md converter. Which is wrong, as python docs come in different shape and sizes. And without some specific parsers/converters is there an actual point in that? |
I wonder if there's a set of "tell-tale" signs that a docstring is in markdown vs rst vs plain text. In such a way that if those signs aren't there, then it's likely it doesn't matter what format we treat it as. e.g. |
ecf3dbe
to
635bf05
Compare
@gatesn I updated this pull requrest In jedi 15.0 author added a proper way to get a signature of a function here which allows us to grab signature and docstring separately, formatting them accordingly. About your comment on For a tell-tale signs - this is a good thing for a research. But as I said earlier - it is a huge amount of work, and docstring at the moment are not highlighted properly. Which is a shame. |
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.
I left a minor comment, otherwise looks good to me.
LSP supports `MarkedString[]` to specify render engine. We can definitely say that function signature should be rendered as python. For the docstring, as we have no good way of parsing it to guess the engine, we can pass it as markdown.
Would love to see this merged, as I'd like the Jedi requirements update |
@ccordoba12 ping on this one ) |
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.
Thanks for your patience @mpanarin!
Hey guys, would you please cut off a new release targeted the latest python-jedi? It seems 0.29.0 milestone is complete anyway 😉 |
LSP supports
MarkedString[]
to specify render engine. We can definitely say that function signature should be rendered as python.For the docstring, as we have no good way of parsing it to guess the engine, we can pass it as markdown.