Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation style update #35

Open
bedantaguru opened this issue Apr 20, 2020 · 8 comments
Open

documentation style update #35

bedantaguru opened this issue Apr 20, 2020 · 8 comments
Labels
Kept for Later This will be implemented in future is required

Comments

@bedantaguru
Copy link
Member

Explore several options to enhance documentation

@bedantaguru
Copy link
Member Author

{callr} has nice documentation...
It may be explored.

@bedantaguru bedantaguru added the Kept for Later This will be implemented in future is required label Apr 20, 2020
@bedantaguru
Copy link
Member Author

Check this for @theme tag in {roxygen}

@bedantaguru
Copy link
Member Author

Check
this line
this blame

@bedantaguru
Copy link
Member Author

bedantaguru commented Apr 28, 2020

It seems {roxygenlabs} is required locally from where the source is generated and then simply we need to delete it before the final release.

@bedantaguru
Copy link
Member Author

bedantaguru commented Apr 29, 2020

I always wondered It would be really nice if RStudio supports clickable links in warning or error or any massages

Look what today I found
rstudio/rstudio#2530

The idea came from following image (these usually arise when clicked on traceback option on a function failure)
image

Seems somebody already got the same idea
see this SO

@bedantaguru
Copy link
Member Author

bedantaguru commented Nov 2, 2020

I recently started working on this (able to only give very limited efforts)

Few aspects got clarity

  1. I always wondered how $ help is working in python modules (when used reticulate). I now think I have some leads : ex src1 (also search .rs.findCustomHelpContext and .rs.getCompletionsEnvironmentVariables in there), ex src 2
  2. Linking to the above context, I'm trying custom auto-complete functions/ features. It seems that is doable at least in a patchy way in RStudio. Ref ex src
  3. As mentioned earlier {roxygenlabs}.. I was able to reproduce the same without that package (locally). Hopefully, I'll be able to create a maintenance package (package meant to decorate or service main packages.. which should not be in CRAN) for that purpose. Now I'll be exploring an alternative to pdf manual fine-tuning (if possible at all).

@bedantaguru
Copy link
Member Author

"Custom Autocomplete in RStudio" finally I'm able to do
See r-rudra/patch

@bedantaguru
Copy link
Member Author

Link to r-rudra/patch#2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kept for Later This will be implemented in future is required
Projects
None yet
Development

No branches or pull requests

1 participant