refining tags in documentation

[kartikeyakirar]

following discussion on insightsengineering/teal.slice#506 (comment)

I refined the rd documentation by removing the @description and @details tags, And using an explicit @description tag to prevent the second and subsequent paragraphs from being turned into the @details. I followed the guide from https://r-pkgs.org/man.html#title-description-details.

[github-actions]

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  ------------------
R/cdisc_data.R                       1       1  0.00%    38
R/default_cdisc_join_keys.R         11      11  0.00%    16-34
R/deprecated.R                      57      57  0.00%    19-344
R/dummy_function.R                   2       2  0.00%    14-15
R/formatters_var_labels.R           36      11  69.44%   60, 69-80
R/join_key.R                        38       0  100.00%
R/join_keys-c.R                     12       0  100.00%
R/join_keys-extract.R              128       0  100.00%
R/join_keys-names.R                 15       0  100.00%
R/join_keys-parents.R               30       0  100.00%
R/join_keys-print.R                 45       0  100.00%
R/join_keys-utils.R                 73       3  95.89%   35-38
R/join_keys.R                       21       0  100.00%
R/teal_data-class.R                 25       1  96.00%   69
R/teal_data-datanames.R             10       0  100.00%
R/teal_data-get_code.R              14       0  100.00%
R/teal_data-show.R                   4       4  0.00%    14-19
R/teal_data.R                       22       9  59.09%   31, 40-46, 49
R/testhat-helpers.R                 26       0  100.00%
R/topological_sort.R                32       0  100.00%
R/utils-get_code_dependency.R      127       0  100.00%
R/verify.R                          42      11  73.81%   63, 93-97, 100-104
R/zzz.R                             10      10  0.00%    4-16
TOTAL                              781     120  84.64%

Diff against main

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

Results for commit: efc85b4

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   14 suites   1s ⏱️
175 tests 173 ✅ 2 💤 0 ❌
243 runs  241 ✅ 2 💤 0 ❌

Results for commit efc85b4.

♻️ This comment has been updated with latest results.

[averissimo]

🎉🚀 It looks good.

I don't like the use of \cr on MD, but it's unavoidable as it will consider any additional paragraph as part of @details (unless we want to keep more instances of @description in addition the the remaining one)

I left a minor comment about markdown list consistency

[github-actions]

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
get_code	💀	$0.01$	$-0.01$	get_code_returns_result_of_length_1_for_non_empty_input
get_code	👶		$+0.01$	get_code_returns_result_of_length_for_non_empty_input
get_code	💀	$0.02$	$-0.02$	get_code_with_datanames_can_extract_the_code_for_objects_assigned_with_data_function
get_code	👶		$+0.02$	get_code_with_datanames_can_extract_the_code_when_function_creates_an_object_which_is_used_only_on_rhs

Results for commit 5e4ff52

♻️ This comment has been updated with latest results.