Open-EO/openeo-r-client

Autocompletion improvements?

Closed this issue · 6 comments

If I use autocompletion/documentation features in R Studio for the core functions like describe_collection or so I get to see something like that:

image

If I do the same for processes I "only" get the following:

image

Is there a way to also add the right part where it shows the signature, parameters, and a summary of the process?

@m-mohr, concerning your second screenshot if you open the brackets of the process and hit tab you should get the arguments. That's already very helpful.
To get the same layout as for "real" R functions (screenshot above), I'm doubtful that if will work with reasonable effort. @flahn?

I know, but maybe we can improve it further? I forgot to mention that I'm just passing along feedback from the user consultation event. Thanks anyway. :-)

flahn commented

The "real" R functions are those which are implemented as components of the package. So their meta data is parsed from the static .Rd documentation files, which are rendered with parameters and description. The object p is created dynamically at runtime and it does not have those static .Rd files. This means that we simply have the benefit of less typing at this point.

Maybe a bit crazy, but could we generate such .Rd documentation for processes (on demand per back-end)?

flahn commented

Unfortunately we can't to my knowledge. We might be able to create such files, but it needs to be integrated into the core package description files. We would need then to integrate the links to the files in the package description, reload the package and of course this changes for each connected back-end.

In short I won't mess with R package integrities. Probably most OS won't allow this either.

Okay, so the only thing we could do is to e.g. make a specific version of the R client for openEO Platform but this is out of scope (for now). Thanks.