`itertools.count` docstring is not shown correctly

[JelleZijlstra]

Environment data

• Language Server version: Pylance 2022.8.30
• OS and version: macOS 11.6.8
• Python version (& distribution if applicable, e.g. Anaconda): Python 3.10.2

Code Snippet

import itertools
itertools.count(1000)

Repro Steps

1. Hover over itertools.count

Actual behavior

Notice how several lines in the code sample are mushed together.

For reference the full docstring is:

Return a count object whose .__next__() method returns consecutive values.

Equivalent to:
    def count(firstval=0, step=1):
        x = firstval
        while 1:
            yield x
            x += step

I suppose this is because the docstring is interpreted as Markdown and therefore adjacent lines are merged.

[judej]

Although there is no marker for code, we could watch for indentation to determine if it is code.

[Eureka-0]

Can I change the font style for this information? I noticed it to use the same font as my editor when using jedi.

pylance, not monospace and too small, hard to read

jedi, the same font as editor, easy to read

[debonte]

@Eureka-0, please open a separate issue on this.

[Eureka-0]

@Eureka-0, please open a separate issue on this.

Ok I opened a new issue here #3278.

[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 :)