` ` not being correctly formatted in documentation

zed-industries / zed

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

https://zed.dev

Other

49.7k stars 3.05k forks source link

` ` not being correctly formatted in documentation #15463

Open failable opened 3 months ago

failable commented 3 months ago

Check for existing issues

[X] Completed

Describe the bug / provide steps to reproduce it

Environment

Zed: v0.146.1 (Zed Preview) OS: macOS 14.5.0 Memory: 32 GiB Architecture: x86_64

If applicable, add mockups / screenshots to help explain present your vision of the feature

No response

If applicable, attach your Zed.log file to this issue.

Zed.log

notpeter commented 3 months ago

Looks like the markdown *serializer* *default* and __structlog__ are not being rendered as italic/underline either, but with other language servers (e.g. LuaLS) that seems to work so this may be a Python (Pyright) specific issue:

Neither correctly render   to so that's definitely a bug.

dovakin0007 commented 2 months ago

https://github.com/pulldown-cmark/pulldown-cmark/issues/713 is it something related to this?

jean-humann commented 2 months ago

@notpeter Seems to be the way Pyright handle whitespace and tabulation in doctoring: https://github.com/microsoft/pyright/blob/386b7fe0a53632e9666ba44d2c0a8ae1e7a9aa4d/packages/pyright-internal/src/analyzer/docStringConversion.ts#L297

failable commented 1 month ago

</br> also not rendered.