Skip to content

150 collate documentation - #166

Merged
chlebowa merged 23 commits into
mainfrom
150_collate_documentation@145_create_qenvs_empty@main
Dec 5, 2023
Merged

150 collate documentation#166
chlebowa merged 23 commits into
mainfrom
150_collate_documentation@145_create_qenvs_empty@main

Conversation

@chlebowa

Copy link
Copy Markdown
Contributor

Closes #150

Collated documentation for qenv, eval_code, within, and get_code into one page (composed of multiple files).

Cleaned up usage sections of all help pages.

Some stylistic updates.

@chlebowa
chlebowa marked this pull request as ready for review November 30, 2023 14:46
Base automatically changed from 145_create_qenvs_empty@main to main December 4, 2023 14:45
@chlebowa
chlebowa requested a review from gogonzo December 5, 2023 08:24
@github-actions

github-actions Bot commented Dec 5, 2023

Copy link
Copy Markdown
Contributor

badge

Code Coverage Summary

Filename                 Stmts    Miss  Cover    Missing
---------------------  -------  ------  -------  ---------
R/qenv-concat.R             10       0  100.00%
R/qenv-constructor.R        16      13  18.75%   54-93
R/qenv-eval_code.R          52       2  96.15%   100, 109
R/qenv-get_code.R           18       0  100.00%
R/qenv-get_var.R            19       0  100.00%
R/qenv-get_warnings.R       24       0  100.00%
R/qenv-join.R               46       0  100.00%
R/qenv-replace_code.R        8       0  100.00%
R/qenv-show.R                1       1  0.00%    19
R/qenv-within.R              7       0  100.00%
R/utils.R                   12       0  100.00%
TOTAL                      213      16  92.49%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 797b2b0

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

@github-actions

github-actions Bot commented Dec 5, 2023

Copy link
Copy Markdown
Contributor

Unit Tests Summary

    1 files    10 suites   0s ⏱️
  68 tests   68 ✔️ 0 💤 0
144 runs  144 ✔️ 0 💤 0

Results for commit 797b2b0.

♻️ This comment has been updated with latest results.

@gogonzo gogonzo self-assigned this Dec 5, 2023

@gogonzo gogonzo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor comments but looks better

Comment thread R/qenv-constructor.R
Comment thread R/qenv-constructor.R
Comment thread R/qenv-constructor.R Outdated
Comment thread R/qenv-within.R
Comment thread R/qenv-within.R
@chlebowa
chlebowa requested a review from gogonzo December 5, 2023 11:18
@chlebowa
chlebowa enabled auto-merge (squash) December 5, 2023 11:18
chlebowa added a commit to insightsengineering/teal.transform that referenced this pull request Dec 5, 2023
Related to insightsengineering/teal.code#166

Replaced old `qenv` constructor with new one.
@chlebowa
chlebowa merged commit e9619d3 into main Dec 5, 2023
@chlebowa
chlebowa deleted the 150_collate_documentation@145_create_qenvs_empty@main branch December 5, 2023 11:20
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 this pull request may close these issues.

[Question]: Should we clean the documentation of new_qenv?

2 participants