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 tgoshawk documentation before release #216

Closed
10 tasks done
donyunardi opened this issue May 25, 2023 · 2 comments · Fixed by #224
Closed
10 tasks done

Review tgoshawk documentation before release #216

donyunardi opened this issue May 25, 2023 · 2 comments · Fixed by #224
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
@npaszty
Copy link
Contributor

npaszty commented May 25, 2023

@donyunardi
please add me to review when the proposed changes to bullet 1, 2, and 5 are pushed.

@m7pr
Copy link
Contributor

m7pr commented Jun 28, 2023

Hey @gogonzo if you started on this one, you may want to know that WORDLIST reduction was made in here #221

@gogonzo gogonzo removed their assignment Jul 10, 2023
@m7pr m7pr self-assigned this Jul 11, 2023
@m7pr m7pr closed this as completed in #224 Jul 12, 2023
m7pr added a commit that referenced this issue Jul 12, 2023
Closes #216 

qenv replaced chunks in this PR
https://github.com/insightsengineering/teal.goshawk/pull/203/files -
this is a backend change and this was not exposed in vignettes and not
exposed in examples. I reviewed examples and vignettes in the last 2
weeks while working on #223 and #221 and I run those examples multiple
times recently. Most of the things marked in #216 were not needed to be
checked, besides the teal.code version bump.
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