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

Merge the documentation page of modules() and module() in one page #1074

Closed
m7pr opened this issue Jan 25, 2024 · 1 comment · Fixed by #1087
Closed

Merge the documentation page of modules() and module() in one page #1074

m7pr opened this issue Jan 25, 2024 · 1 comment · Fixed by #1087
Assignees
@chlebowa
Labels
core question Further information is requested

Comments

@m7pr
Copy link
Contributor

m7pr commented Jan 25, 2024 •
edited
Loading

Initially raised in here #1073 by @chlebowa
Similar issue is fixed here for unified documentation for slices_store and slices_restore #1072 by @averissimo

Since examples are very similar for modules() and module() function, and since modules() have almost no params documented, maybe it's convenient to join documentation pages of those two into one manual page, especially since they are very similar and used together.
@m7pr m7pr added question Further information is requested core labels Jan 25, 2024
@m7pr m7pr changed the title [Question]: Should we merge the documentation page of modules() and module() in one page Should we merge the documentation page of modules() and module() in one page Jan 25, 2024
@m7pr m7pr mentioned this issue Jan 25, 2024
Merged
@donyunardi donyunardi mentioned this issue Jan 26, 2024
Closed
36 tasks
@donyunardi
Copy link
Contributor

Let's merge them, thanks @m7pr !

@m7pr m7pr changed the title Should we merge the documentation page of modules() and module() in one page Merge the documentation page of modules() and module() in one page Feb 2, 2024
@chlebowa chlebowa mentioned this issue Feb 5, 2024
Merged
@chlebowa chlebowa linked a pull request Feb 5, 2024 that will close this issue
1074 merge documentation #1087
Merged
chlebowa added a commit that referenced this issue Feb 5, 2024
@chlebowa @m7pr
1074 merge documentation (#1087)
1439cda 
Closes #1074 

Combined documentation for `module` and `modules`, as well as their
methods, in one `Rd` file, `teal_modules`.
Modified `format` methods because line breaks were lacking.
Slightly reworded documentation.
Cleaned up examples for `module(s)`.
Fixed typo in `reporter_previewer_module.R`.

---------

Signed-off-by: Aleksander Chlebowski <114988527+chlebowa@users.noreply.github.com>
Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com>
@chlebowa chlebowa closed this as completed Feb 6, 2024
@m7pr m7pr mentioned this issue Feb 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chlebowa chlebowa

Labels
core question Further information is requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

1074 merge documentation insightsengineering/teal
3 participants
@donyunardi @chlebowa @m7pr