Skip to content

Improve Task documentation #1003

Description

@gowerc

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 ?

Activity

  1. github-actions commented on Feb 17, 2023

    @github-actions

    This issue is stale because it has been open for 365 days with no activity.

  2. gowerc commented on Feb 18, 2023

    @gowerc
    ContributorAuthor

    unstale

  3. github-actions commented on Feb 20, 2024

    @github-actions

    This issue is stale because it has been open for 365 days with no activity.

  4. gowerc commented on Feb 20, 2024

    @gowerc
    ContributorAuthor

    Unstale

  5. ThomasSoeiro commented on Sep 27, 2026

    @ThomasSoeiro
    Collaborator

    @gowerc You are welcome to go ahead and update the wiki yourself :)

  6. ThomasSoeiro commented on Sep 27, 2026

    @ThomasSoeiro
    Collaborator

    see also #59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions