Wrong docstring shown for nn.LayerNorm.__init__

[jingw222]

What we have:

which only shows a very terse signature. How do we get the full docstrings:

as in Jupyter:

Screen.Recording.2021-09-02.at.12.46.37.AM.mov

[karthiknadig]

@jingw222 Are you using pylance or jediLSP as the language server?

[jingw222]

@jingw222 Are you using pylance or jediLSP as the language server?

Thanks for asking. I'm using the latest pylance.

Version: 1.59.1
Commit: 3866c3553be8b268c8a7f8c0482c0c0177aa8bfa
Date: 2021-08-19T11:53:52.479Z
Electron: 13.1.7
Chrome: 91.0.4472.124
Node.js: 14.16.0
V8: 9.1.269.36-electron.0
OS: Darwin x64 20.6.0

[jakebailey]

What project is this, pytorch? Yes, pytorch; should have looked at the screencast.

That doc is likely Module's docs; we have a bug at the moment where we return the parent class' __init__ doc before we offer up the class's docs itself. You can confirm this by hovering over LayerNorm without calling it, or hovering over the class name at its declaration.

[jakebailey]

I'm going to close this in favor of #1047, which is the same issue (and I've retitled it to better represent the problem).

[jingw222]

This issue has been announced as fixed in the Pylance v2021.9.1 release as you said in the linked issue. But The hover box still shows me what it was before. What gives?

[jakebailey]

Later in that issue, we decided that this particular behavior wasn't a necessarily a bug; it's unclear whether or not the parent class's init doc is the more useful one if the class doc also exists. Other editors appear to behave similarly to us, except that we show the init doc when invoking a class (which calls init).

The other issue was in fact actually fixed (as it involved a doc from object), but this particular issue is entirely between non-builtin classes.