not being correctly formatted in documentation

[failable]

Check for existing issues

• 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]

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]

pulldown-cmark/pulldown-cmark#713 is it something related to this?

[jean-humann]

@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]

</br> also not rendered.

[notpeter]

From @tkz789 comment in #16980 (merged into this issue)

It seems to be a general error with all python docstrings I saw. Whenever there are spaces at the beginning of the line resulting in indentation, it is parsed to &nbsp.

[notpeter]

Pyright appears to be converting all leading spaces from docstrings into a series of   in an attempt to preserve hanging indentation which would otherwise get collapsed to a single space. link

pulldown_cmark (which Zed uses for Markdown rendering) has decided this is correct behavior to preserve raw HTML escapes inside other HTML blocks. So Zed likely needs to reconvert these   into again. E.g. s/ / /g