search

posit-dev / positron

Positron, a next-generation data science IDE
https://positron.posit.co
Other
2.78k stars 85 forks source link

ark: Show more succinct package summaries #572

Open jmcphers opened 1 year ago

jmcphers commented 1 year ago

To reproduce, type library(ggplo in the Console. ARK returns the entire help page for the package:

image

Compare with RStudio, which just shows the summary:

image

I think ARK should also just show the summary since the full-page help is distracting (covers too much of the UI) and puts the most useful information too far from your eyes; here it's the package maintainer list that shows up next to your cursor.

juliasilge commented 9 months ago

Can we use this issue to track showing more succinct info for functions here too?

In RStudio, we only see the function signature. Right now in Positron we try to show the whole function help page and a) it is distracting (I think also covers too much of the UI) and b) as reported by @thomasp85 we aren't rendering things correctly (tables/lists):

image

DavisVaughan commented 9 months ago

This annoys me so much that I just turn it off

juliasilge commented 9 months ago

From @thomasp85:

As is it is too distracting - especially with the speed at which it appears by default

Either it should be constrained in viewport size (and scrollable) or it should be condensed like in RStudio

If it were condensed it would be nice to have a shortcut to bring it up in the Help pane without losing focus from where you are typing

I really like that last option ⤴️

jmcphers commented 8 months ago

Probably RC since we've gotten so much feedback that this needs fixing