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

Vignette improvements #35

Closed
4 tasks done
thomaszwagerman opened this issue Jan 8, 2025 · 1 comment
Closed
4 tasks done

Vignette improvements #35

thomaszwagerman opened this issue Jan 8, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thomaszwagerman
Copy link
Collaborator

thomaszwagerman commented Jan 8, 2025

Reviewer comments on vignettes:

  • Impove main vignette introduction. From the reviewer: "The main vignette doesn't really start with an intro that clearly explains what the package is doing. The brief intro sentences may be slightly confusing. I would recommend adding another sentence or two explaining in big-picture terms what are the inputs you would need, and what outputs/results you should expect to get."
  • Mention scripts are run in Bash shell.
  • Hide JOSS vignette until it is ready.
  • Grammar and punctuation check.

See ropensci/software-review#676

@thomaszwagerman thomaszwagerman added the documentation Improvements or additions to documentation label Jan 8, 2025
@thomaszwagerman thomaszwagerman self-assigned this Jan 8, 2025
@thomaszwagerman
Copy link
Collaborator Author

Hiding vignettes is not really possible, like it is with draft quarto pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant