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

Review tosprey documentation before release #204

Closed
donyunardi opened this issue May 25, 2023 · 0 comments · Fixed by #216
Closed

Review tosprey documentation before release #204

donyunardi opened this issue May 25, 2023 · 0 comments · Fixed by #216
Assignees
Labels

Comments

@donyunardi
Copy link
Contributor

donyunardi commented May 25, 2023

Summary

Related with insightsengineering/nestdevs-tasks#25
In preparation to release, we need to review/assess all documentation in the package.

Acceptance Criteria

  • Review roxygen examples on all functions
    • Test examples
    • If it's using chunk, update to qenv.
  • Review vignettes on these topics only:
    • Review any content around qenv
    • Review any content around chunks (i.e. make sure the right language around deprecation)
    • Review any content around shinyvalidate
  • redo the content of WORDLIST
  • Update NEWS
  • Update README (if applicable)
  • Review DESCRIPTION file (i.e check dependency versions, etc)
    • Be sure to update teal.code dependency to be >= 0.3.0
@gogonzo gogonzo self-assigned this Jun 30, 2023
This was referenced Jun 30, 2023
@gogonzo gogonzo removed their assignment Jun 30, 2023
@chlebowa chlebowa assigned chlebowa and unassigned chlebowa Jul 6, 2023
@m7pr m7pr self-assigned this Jul 12, 2023
m7pr added a commit that referenced this issue Jul 13, 2023
@m7pr m7pr closed this as completed in #216 Jul 13, 2023
m7pr added a commit that referenced this issue Jul 13, 2023
This closes #204 

@gogonzo there is one example that fails - #215 - besides that they all
run fine. There is no `teal.code::chunks` narration exposed in examples
nor vignettes. Also the `teal.code` was already at 0.3.0 so no need to
update DESCRIPTION file. I don't think I am able to resolve #215 even
though I tried a couple of times.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants