REditorSupport / REditorSupport/vscode-R

Improve Task documentation

Open
#1,003 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
TypeScript
Stars
1.2k
Forks
139
Avg merge
2h 46m
Merged PRs (30d)
5

Description

Just adding this as a todo to make sure it doesn't get lost.

We discussed and agreed that it would be good to flesh out the documentation for tasks. @renkun-ken highlighted the following:

Yes, of course. I'll add an entry to Features which points to Tasks in wiki. If you are interested, you could directly edit the wiki page.

I'm thinking that we need to cover the following:

  • Very very basic introduction to what tasks are and how to launch them (then point to vscode docs for more details)
  • Highlight the pre-build R tasks (test, install, document, etc) and point out how they can be accessed via "run test tasks" (also highlight the prerequisite for a DESCRIPTION file
  • Also highlight that the Test task integrates with the problems pane to highlight the exact unit tests that failed
  • Show how users can customise the default tasks using the spanner icon and then how they can just thinks such as the R options i.e. --silent
  • Finally show users how our exported task definition allows them to right custom tasks purely in R code

Maybe this is a bit much but it would cover everything. Any other thoughts ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Features page and Tasks wiki page, then compare the existing task documentation with the requested topics: launching tasks, pre-built R tasks, the DESCRIPTION prerequisite, problems-pane integration, customization, and custom R task definitions. Done means the Features entry points to the wiki and the wiki explains these task workflows clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
r, vscode
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.