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

Relaying some user-facing API feedback #28

Open
dgkf-roche opened this issue Aug 19, 2024 · 0 comments
Open

Relaying some user-facing API feedback #28

dgkf-roche opened this issue Aug 19, 2024 · 0 comments

Comments

@dgkf-roche
Copy link
Collaborator

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant