REditorSupport / REditorSupport/vscode-R

Improve Task documentation

Aperta
#1,003 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature-request
Lingua principale
TypeScript
Stelle
1.2k
Fork
139
Merge medio
3h 33m
PR unite (30g)
6

Descrizione

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 ?

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina Features collegata e dalla pagina wiki Tasks, quindi confronta la documentazione esistente delle attività con gli argomenti richiesti: avvio delle attività, attività R predefinite, prerequisito DESCRIPTION, integrazione con problems-pane, personalizzazione e definizioni di attività R personalizzate. Il lavoro è completato quando la voce Features rimanda al wiki e il wiki spiega chiaramente questi flussi di lavoro delle attività.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
r, vscode
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
28/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.