ST2 function tooltip for R
- Dominant language
- Python
- Stars
- 33
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
building on my last issue, the actual goal is to have function tooltip as shown here for Notepad++ (second screenshot):
http://yihui.name/en/2010/08/auto-completion-in-notepad-for-r-script/
That would really be useful but the current ST2 architecture only offers limited ways to do that. Take a look at this thread for a discussion about that:
http://www.sublimetext.com/forum/viewtopic.php?f=2&t=2670
and you can also cote for the issue here:
http://sublimetext.userecho.com/topic/54838-/
As long as ST2 does not support tooltips, a workaround would be to put the function help in the status bar. SublimeCodeintel does that for some languages. I think that the content of the tooltips can be automatically generated from R and saved in a json file (based on the script of the completion file I mentioned in the other issue). For example, for rnorm the tooltip should look like
rnorm(n, mean = 0, sd = 1)
to show the arguments and the default values.
If you are interested in working on this, I could cover the R side (i.e. automatically generate the json file with the tool tips). Maybe there is also a better way to achieve this...
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the Sublime Text tooltip discussion linked in the issue and the existing SublimeCodeIntel status-bar behavior. Determine whether ST2 can support tooltips; if not, define the status-bar fallback and the JSON generated from R, with function signatures such as rnorm(n, mean = 0, sd = 1) as the completion criterion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100