Skip to content

Relaying some user-facing API feedback #28

@dgkf-roche

Description

@dgkf-roche

run()

  • documentation describes output reporter chosen for "capable" terminals (which implicitly meant more capable than RStudio, which does not permit multi-line dynamic output). Would be more useful to most users if it was more explicit about RStudio behavior since it is so widely used.
  • Disappointed that RStudio output isn't as pretty
  • First argument is design, but it accepts a path. Unclear what a "design" is and why it's used here.
    • Suggestion: maybe just rename to x if it's going to be this widely generic?
  • Perhaps it should default to the current directory like most check'ing functions?

Output

  • How to emit a markdown report? should have instructions in readme
  • Perhaps include as top-level argument so it's more obvious how to save out results

Other feedback

  • still not clear what a "design" is... maybe a sign that we need more intuitive names

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions