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.

Sign up for GitHub

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

Jump to bottom

Documentation fixes #818

Closed
asbates opened this issue Apr 3, 2023 · 1 comment · Fixed by #869
Closed

Documentation fixes #818

asbates opened this issue Apr 3, 2023 · 1 comment · Fixed by #869
Assignees
@m7pr
Labels
core

Comments

@asbates
Copy link
Contributor

asbates commented Apr 3, 2023 •
edited by gogonzo
Loading

There are a couple of issues (some potential) noted in the review of documentation in #815. I think they need more discussion, hence this issue.

  • The vignette "Adding support for Reporting to custom modules" uses qenv in an example. I think we should add a short description of qenv, point to teal.code, or remove the qenv usage possible.
  • The examples in module_tabs_with_filters uses :::. These shouldn't be used.
  • I don't understand the purpose of the second example in module_tabs_with_filters. If it doesn't add anything helpful it should be removed. Similar examples are used in other teal functions so they may need updating as well
  • Similarly for module_teal. It uses ::: and I'm not sure the example is helpful.
@asbates asbates mentioned this issue Apr 3, 2023
Merged
@donyunardi donyunardi mentioned this issue Apr 3, 2023
Open
asbates added a commit that referenced this issue Apr 5, 2023
@asbates
Documentation fixes for release review (#819)
08e2917 
Fixes a few documentation issues that need to be addressed for release.
Note that not all items from #815 are in this PR. Some of them need
discussion, so I opened #818.

Closes #815
@m7pr m7pr self-assigned this Jul 21, 2023
m7pr added a commit that referenced this issue Jul 21, 2023
@m7pr
#818 enhance the text of support-for-reporting vignette
3fa1195
@m7pr m7pr mentioned this issue Jul 21, 2023
Merged
@m7pr
Copy link
Contributor

m7pr commented Jul 27, 2023

blocked by #870

@m7pr m7pr added blocked and removed blocked labels Jul 27, 2023
@m7pr m7pr closed this as completed in #869 Jul 28, 2023
m7pr added a commit that referenced this issue Jul 28, 2023
@m7pr @chlebowa @github-actions
818 documentation cleanup (#869)
4dea971 
Closes #818 

With this PR we aimed to explain `teal.code` usage in `Adding support
for Reporting to custom modules` vignette. This vignette demonstrates
the usage of `teal.reporter` modules with `teal` apps. The example with
`teal.code` is not necessary for the vignette however it shows an
advanced combination of usage of `teal.code` and `teal.reporter` hence I
decided not to remove `teal.code` snippets from this article.

There are also `teal.code` snippets in another vignette (`Creating
Custom Modules`), so removal from this one would not remove the Suggests
dependency for the `teal.code` package anyway.

I also reviewed the text and tried to polish it. 

Lastly, there examples in `R/module_tabs_with_filters.R` were updated
during #870

---------

Signed-off-by: Marcin <[email protected]>
Co-authored-by: Aleksander Chlebowski <[email protected]>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@m7pr m7pr

Labels
core
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

818 documentation cleanup insightsengineering/teal
3 participants
@donyunardi @asbates @m7pr