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

Fix doc comment line splits for the first paragraph or report issue with tooling #58

Closed
chanced opened this issue Jul 9, 2024 · 4 comments

Comments

@chanced
Copy link
Owner

chanced commented Jul 9, 2024

          This is what I mean:
Screenshot 2024-07-08 at 21 24 56

Versus:
Screenshot 2024-07-08 at 21 27 03

Originally posted by @asmello in #56 (comment)
...
Strangely enough, vscode gets it right.
Screenshot 2024-07-08 at 4 35 24 PM

Originally posted by @chanced in #56 (comment)

@asmello
Copy link
Collaborator

asmello commented Jul 9, 2024

I've clarified it with Jon, and as it turns out his remark about the first line having special treatment was about the first line under markdown semantics - delimited by \n\n - so I think this is actually ok. It does seem unintended to have the newlines reproduced raw in the hover docs, but I tested with vscode and I can't reproduce, so it seems that rust-analyzer sends the raw markdown and it's up to the editor to render how they choose. So I guess this is on Helix to fix.

Sorry about the false alarm! Will close out, hope you haven't wasted energy changing this yet.

@asmello asmello closed this as completed Jul 9, 2024
@chanced
Copy link
Owner Author

chanced commented Jul 9, 2024

I dont think this was a false alarm, but rather that some tooling in the ecosystem isn't properly parsing markdown, or at least not rendering it properly.

The screenshots were from neovim right? I wrecked my config for neovim and just haven't had the time to go back and rectify that. I kinda got sucked into the easiness of vscode with vim bindings and just got lazy, I guess.

I guess its time I got around to fixing it.

@asmello
Copy link
Collaborator

asmello commented Jul 9, 2024

The screenshots were from neovim right? I wrecked my config for neovim and just haven't had the time to go back and rectify that. I kinda got sucked into the easiness of vscode with vim bindings and just got lazy, I guess.

Actually I use Helix! If you're used to Neovim, Helix is probably not quite mature enough yet for a migration, but since I never used Neovim in the first place I figured I may as well skip straight into the next thing.

@chanced
Copy link
Owner Author

chanced commented Jul 9, 2024

Ah, helix is quite nice. I actually prefer the movements in it. The only reason I haven't switched is the lack of a plugin system. Well, that or a file tree (not sure why I'm so dependent on one).

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