missing new line from dict() help mouse hover

[Devid-Ba]

Environment data

• Language Server version: 2022.7.40
• OS and version: linux x64
• Python version (and distribution if applicable, e.g. Anaconda):
• python.analysis.indexing: null
• python.analysis.typeCheckingMode: basic

Code Snippet

XXX

Repro Steps

1. hover over dict()

Expected behavior

newline after d = {}.

Actual behavior

screen shot from help(dict)

Logs

XXX

[heejaechang]

doc string formatter issue.

[rchiodo]

Looking at this in the context of supporting restructured text. Builtins are not in restructured text format.

The docstring for dict for example is this:

dict() -> new empty dictionary
dict(mapping) -> new dictionary initialized from a mapping object's
    (key, value) pairs
dict(iterable) -> new dictionary initialized as if via:
    d = {}
    for k, v in iterable:
        d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs
    in the keyword argument list.  For example:  dict(one=1, two=2)

Parsing this into rest, it's just one big paragraph.

Paragraphs (when shown in Markdown) eliminate extra tabs on purpose. Otherwise something like this wouldn't wrap correctly:

this is a paragraph with extra
   lines that continue after a tab.

[rchiodo]

Builtins may then have to be formatted literally. Or at least special cased to add literal indents.

[rchiodo]

This issue has been fixed in prerelease version 2024.6.100, which we've just released. You can find the changelog here: CHANGELOG.md

[rchiodo]

The fix for this issue is behind an experimental feature flag:

"python.analysis.supportRestructuredText": true

If you want to try out our new restructuredText support, enable this flag. It's behind a flag at the moment until we can make sure it handles all the possible Sphinx/GoogleDoc/Epytext scenarios that customers need. Please log additional issues if this setting isn't working out for you.

Thanks :)