DISCUSSION: How to display docstrings?

[lgeiger]

Future versions of ipykernel will support additional docstrings. See ipython/ipykernel#249

I played a bit around with different ways of displaying them, let me know what you think:

Option 1: Description and function signature

Option 2: Only description

Option 3: Description and function signature as a snippet

This will complete the whole shown string:

Option 4: Description and function signature as right label

[rgbkrk]

/cc @Carreau

[rgbkrk]

I like (3) best.

[BenRussert]

I like (3), but don't know if i'd always want the whole signature completed. Might change my mind if I try it live.

(1) looks great too.

[t9md]

I like "Option 2: Only description".
Because when I use autocomplete I normal use it for just complete the word I already know of.

So at least for me, extra information is bit noisy( I explicit refer document or src code if I want those info).

[idea] use these signature info as dynamic snippet? dynamically create snippet, and tab can expand these snippet.

[Carreau]

One other possibility is to have the signature be "display:none" except when selected by the cursor.

• 1: 😐
• 2: 😐
• 3: 👍
• 4: 👎

[dnowacki-usgs]

I like (1) best, then (2).

I do not like (3); completing the whole snippet seems overkill... but maybe I'm missing the point.

(4) is ok but I don't see much improvement (or difference) compared to (1).