Full name data gets mixed with docstrings

[valery-arzumanov]

Hello!

I'm having problems with docstring tooltips (I stick to Google Style Guide). When I hover over an item, for instance, over a function, which has a docstring, containing argument description, "Full name" block goes right after the description of the argument without any space or a line feed, which creates a messy view. Is it a bug or a feature? Is it possible to prevent "Full name" block from appearing?

Thank you!

[tyrese-09]

Hello, I think so that it's a feauture and if you worry about it you have to use a other language or something like that cause this Language is for people who are begiiner Programmers or has t write a code for the first time.

[rchiodo]

The output there is a function of the format of the docstring. It's using restructured text format and the part you're showing as useless is in the docstring somewhere. What's the actual docstring?

[valery-arzumanov]

Thank you for your feedback! The word 'useless' is just a docstring for a variable name — I might've as well called it 'stub' or 'dummy'. The thing is that there is no "Full name" part in my docstring — it's autogenerated (you might as well see the same with your own function in Python) and I want to suppress it, if it's possible.

[rchiodo]

I need to know the actual docstring to understand why it's generating that output. It doesn't make sense why it would generate 'Full name' as we don't have that in our code anywhere. It might be in the restructure text parser we use and that output is supposed to be a reference to a type.

You can always turn off restructured text parsing with this setting:

[valery-arzumanov]

I guess, that'd probably do the job, but I don't have such a setting. In fact, I have no "Analysis" block at all. If you can find no code, constructing the message of the tooltip, it must be somewhere else — a third-party lib, perhaps.

P. S. Since you're really interested in the tooltip, I'd rather switch to a real-life example, lest it should lead to any confusion. I doubt, it would be of any use, but following is the code of a function and a corresponding screenshot of a problematic tooltip.

def get_type_name(variable: typing.Any) -> str:
    """ 
    Gets the variable type name

    Parameters
    ----------
    variable : `typing.Any`
        the variable
    
    Returns
    -------
    `str`
        variable type name
    """

    return type(variable).__name__

[rchiodo]

If you don't have that setting in VS code, I don't think you're using pylance. At least not anything since the last year or so.

That same docstring produces this for me:

[valery-arzumanov]

Well, you're right. That's not Pylance. That's just "Python", the README of which reads, "it would install Pylance automatically", but I don't have it. This is that point, which led me astray. Thank you very much indeed for clearing that out! I guess, I should start a discussion here then?

[rchiodo]

You might have your python.languageServer setting set to 'None' or maybe 'Jedi'. That would likely cause this issue.

[rchiodo]

Otherwise, yes the Python extension should install the Pylance extension by default.

[valery-arzumanov]

Thank you again! I've fixed that by changing the server to "Pylance" and installing Pylance manually. One more question, is the font size of block names like "Returns" customizable? I'd prefer a smaller one.