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

chanced / jsonptr

JSON Pointer (RFC 6901) implementation for Rust

Apache License 2.0

44 stars 4 forks source link

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

Closed chanced closed 1 month ago

chanced commented 1 month ago

          This is what I mean:

Versus:

_Originally posted by @asmello in https://github.com/chanced/jsonptr/pull/56#discussion_r1669268761_ ... Strangely enough, vscode gets it right.

_Originally posted by @chanced in https://github.com/chanced/jsonptr/pull/56#discussion_r1669278695_

asmello commented 1 month ago

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.

chanced commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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