Support restructured text in Pyright language server #6631
Replies: 5 comments 18 replies
-
|
The Microsoft Pylance team owns and maintains the docstring formatting functionality that is included in pyright. Could someone from the pylance team please transfer this issue to the pylance-release project? Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
Restructured text is only currently supported in Pylance (inside of VS code). Moving this to a discussion item for upvotes. |
Beta Was this translation helpful? Give feedback.
-
|
I see the same issue. In the original code documentation, the plain white spaces are converted to |
Beta Was this translation helpful? Give feedback.
-
|
i mean that is fine if it is sending something that is correctly rendered in the end. maybe it sends &nobsp; and i can just configure nvim to not show that even on hover, this is reasonable. however there is still the issue of the escaped chars with the slash and most annoying is that whatever mehtod is used for indent, it doesnt respect the indentation in the file. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah, that would be plain text mode. Plain text mode is supposed to return the same text as in the docstring as the hover text. Indents would be the same and all spaces would be just spaces. |
Beta Was this translation helpful? Give feedback.
-
|
where could one find docs on the plain text mode? |
Beta Was this translation helpful? Give feedback.
-
Hi, I have replied to your original reddit post in neovim reddit. Please check there 🙏 |
Beta Was this translation helpful? Give feedback.
-
|
https://www.reddit.com/r/neovim/comments/1gdv1rc/what_is_causeing_the_lsp_hover_docs_to_looks_like/ just so this thread has this link i guess |
Beta Was this translation helpful? Give feedback.
-
|
i still feel that there should be some other option for formatting that includes some regular markdown view. |
Beta Was this translation helpful? Give feedback.
-
|
is that something that could be implimented in the future or should i switch away from pyright in order to get this working correctly? |
Beta Was this translation helpful? Give feedback.
-
|
Pylance supports it at the moment (meaning you have to use VS code). This discussion item is to see how many people are asking for this support outside of VS code. My guess is no, this won't be implemented in Pyright. |
Beta Was this translation helpful? Give feedback.
-
|
so i though that pyright was using pylance in order to provide the hover docs. what about the responce from pylance differs if you use vscode over any other editor? if the responce is the same then what is vscode doing to that to make it format nicely? |
Beta Was this translation helpful? Give feedback.
-
|
Sorry but pyright and pylance are not using the same logic. We have custom logic in Pylance only that provides way more parsing around reST output. And that parsing then does a bunch of extra work to generate appropriate markdown output. It was originally done this way because we didn't know if it would work and we didn't want to break Pyright's existing hover documentation. The question now is whether or not it's worth pushing this new hover provider down to Pyright. It's better in some regards but still has bugs in it: |
Beta Was this translation helpful? Give feedback.
-
|
I mean i think that this should be pushed down under some experimental flag/ something that is opt in to enable. There are bugs in most things so i dont think excluding it from pyright becuase it has bugs is really that bad and from what i can see of those issues they dont really interact with the markdown view in the normal cases. I dont know the complexity of implimenting the pylance logic into the pyright hover docs but would be nice to have the option if the code already exists for the more complex restructred text parsing. |
Beta Was this translation helpful? Give feedback.
-
|
has there been any update for this topic? |
Beta Was this translation helpful? Give feedback.
-
|
Sorry but no updates. It's not on our plan at the moment. |
Beta Was this translation helpful? Give feedback.
-
Explanation and Screenshot
A clear and concise description of the behavior you are seeing and the expected behavior along with steps to reproduce it.
Pyright does not provide the correct formatting for docstrings of the numpy type format, see pic below.
The syntax has escapes for all the underscors, square brackets. Also there is an issue with the indentation in the hoverdocs where the indentation is correct in the docstring but it gets ignored past the first line for each parameter, kwarg etc.
This is with pyright installed in Neovim. using Mason to install and manage it. Using nvim-lspconfig to configure the language sever. The hover docs provider is the one provided by Nvim.
I have looked through the lsplogs and found that the text sent to the hover docs is exactly as written out here including the slashes infront of the underscores etc. The only thing that Nvim is doing is replacing the characters with whitespace untill visually selected. pic below shows the visual selection over that range showing the   chars.
Ideally the text sent to the hover docs would only have the whitespace chars instead of the , or at least it should maintain the use of the to continue the indentation inline with what is in the docstring. Also the misc slashes should be gone.
Please let me know if i should provide any more information to help solv but i believe this is a bug that should be fixed within pyright rather than a Nvim thing.
Thank you
Beta Was this translation helpful? Give feedback.
All reactions