search

marimo-team / marimo

A reactive notebook for Python — run reproducible experiments, execute as a script, deploy as an app, and version with git.
https://marimo.io
Apache License 2.0
7.68k stars 265 forks source link

docstring popup for functions when in brackets #2080

Open robaki opened 2 months ago

robaki commented 2 months ago

Description

I can see that there is a docstring popup when hovering over function/object, but using this requires grabbing a mouse and moving it. In jupyter lab when you're writing within function's brackets you can shit+tab to show/hide a docstring popup. It would be great to have something like that here too.

Suggested solution

No idea how to implement it.

Alternative

No response

Additional context

No response

akshayka commented 2 months ago

You can use Ctrl+Space to toggle completion. Use it at the end of a symbol to toggle the docstring for that symbol. Does that work for you? You can remap the command via the keyboard shortcuts option in the notebook hamburger menu.

robaki commented 2 months ago

OK, I see there are suggestions for autocomplete which show the names of keyword arguments. This is useful, but not full info (not sure if providing it is withing the scope of this project then). Also hitting Ctrl+Space the second time doesn't hide them for me, once they show up --- typing some more or deleting text does.

I just also realized that the hover pop-ups show only function signature, not docstrings themselves, at least for pandas.read_csv method:

this is jupyter: image

this is marimo (note that this is the end of the pop-up and it's still showing the function signature): image

akshayka commented 2 months ago

OK, I see there are suggestions for autocomplete which show the names of keyword arguments. This is useful, but not full info (not sure if providing it is withing the scope of this project then)

It's within scope — we can improve this.

I just also realized that the hover pop-ups show only function signature, not docstrings themselves, at least for pandas.read_csv method:

For most methods the docstring shows up. I'm not sure why pandas.read_csv's docstring isn't showing up, I see the same issue on my end. We can try to improve this too. Thank you for reporting.