full function diagnostic ?

moodymudskipper commented 2 years ago

This should probably live in other package.

It's basically a replacement for help.

We call help if relevant (if help exists)
In the viewer pane we have a report with tabs
one tab for flow_view()
one tab for flow_view_deps() (each direction)
one table for flow_view_vars()
one tab for examples from the doc
show all uses of said function in package using "Find in files" tab
If it's a method, or a generic, one tab to show the generic, all the available methods and in which package they live
would be nice to show if it's exported or not, it's not so easy to know when working with {devtools}

If we go one step further and make it interactive (ideally without shiny) we can have buttons to export or view the diagrams, and we might debug, debugonce, flow_debug, flow_debugonce, boomer::rig_in_namespace.

If it's a manufactured closure it would be nice to give info about its parent. We can't tell if a function is manufactured strictly but usually if it's not defined in .GlobalEnv or a namespace then it's one.

If it's overriding a homonym (or more) it should be displayed too.

Would be fancy to try to determine statically what are the types of its body's variables.

moodymudskipper commented 2 years ago

I think the simple version is not that hard to do and brings good value already, and using it we'll find more inspiration on the way.

moodymudskipper commented 2 years ago

https://twitter.com/antoine_fabri/status/1479083069655207944

the jrc package seems to be the answer :

https://github.com/anders-biostat/jrc

moodymudskipper commented 2 years ago

Rather than a replacement for help(), let's make it a replacement for print.function

moodymudskipper / flow

full function diagnostic ? #90