Cross product of patrick test cases

se-sic / coronet

coronet – the R library for configurable and reproducible construction of developer networks

GNU General Public License v2.0

7 stars 15 forks source link

Cross product of patrick test cases #225

Closed joba00002 closed 2 years ago

joba00002 commented 2 years ago

This will be a useful utility for several new tests that are planned.

Signed-off-by: Jonathan Baumann joba00002@stud.uni-saarland.de

Prerequisites

[x] I adhere to the coding conventions (described here) in my code.
[X] I have updated the copyright headers of the files I have modified.
[X] I have written appropriate commit messages, i.e., I have recorded the goal, the need, the needed changes, and the location of my code modifications for each commit. This includes also, e.g., referencing to relevant issues.
[X] I have put signed-off tags in all commits.
[X] I have updated the changelog file NEWS.md appropriately.
[X] I have checked whether I need to adjust the showcase file showcase.R with respect to my changes.
[X] The pull request is opened against the branch dev.

Description

Changelog

joba00002 commented 2 years ago

Could you please add an abstract example showing how your new function can be used?

It also maybe an idea to add this abstract example to the function documentation to ease reuse of the function.

Where exactly should I put such an example? If by function documentation, you mean the documentation comment above it, then I'm not sure if I would put an example there. It would take up a fair amount of space, although it would be easy to find there.

bockthom commented 2 years ago

Where exactly should I put such an example? If by function documentation, you mean the documentation comment above it, then I'm not sure if I would put an example there. It would take up a fair amount of space, although it would be easy to find there.

My idea was to put it in the roxygen2 function documentation, that is, directly before explaining the parameters via @param. We don't care about how much space it takes. More importantly, such an example would tell the user how this function can be practically used---and the function documentation would be the place where I would look for examples.

If you do think that such an example would be way too long (what I cannot imagine yet), you can also post the example here first before integrating it into the codebase.