From 67351251c835cb35b22e88251fe1022090083635 Mon Sep 17 00:00:00 2001 From: Alan Haynes Date: Fri, 25 Oct 2024 11:20:39 +0200 Subject: [PATCH] add space --- wi/review_tests.qmd | 2 ++ wi/running_tests.qmd | 2 ++ wi/testing.qmd | 2 ++ 3 files changed, 6 insertions(+) diff --git a/wi/review_tests.qmd b/wi/review_tests.qmd index 1359c7f..f53857f 100644 --- a/wi/review_tests.qmd +++ b/wi/review_tests.qmd @@ -14,6 +14,7 @@ format-links: --- ::: {.callout-note collapse="true" title="Document development, review and version history"} + ***Development and Review*** | | Name | Date | @@ -27,6 +28,7 @@ format-links: | Version | Date | Author | Summary of Changes | |---------|------------|-------------|--------------------| | 0.1 | xxxx-xx-xx | XXXXXXXXXX | Initial draft | + ::: Once someone has prepared one or more tests for functions in a package and submitted them to be incorporated into the platform via a pull request. They should then be reviewed by another member of the platform, ideally from another unit, to check that the tests are programmed and documented appropriately. diff --git a/wi/running_tests.qmd b/wi/running_tests.qmd index d2b4792..082b37e 100644 --- a/wi/running_tests.qmd +++ b/wi/running_tests.qmd @@ -14,6 +14,7 @@ format-links: --- ::: {.callout-note collapse="true" title="Document development, review and version history"} + ***Development and Review*** | | Name | Date | @@ -27,6 +28,7 @@ format-links: | Version | Date | Author | Summary of Changes | |---------|------------|-------------|--------------------| | 0.1 | xxxx-xx-xx | XXXXXXXXXX | Initial draft | + ::: Although the unit of testing is the function, for organisational purposes, the tests are grouped by package. This is because the tests are run in the context of the package, and eases the process of running and reporting tests. diff --git a/wi/testing.qmd b/wi/testing.qmd index d937980..f7ce2df 100644 --- a/wi/testing.qmd +++ b/wi/testing.qmd @@ -21,6 +21,7 @@ execute: --- ::: {.callout-note collapse="true" title="Document development, review and version history"} + ***Development and Review*** | | Name | Date | @@ -34,6 +35,7 @@ execute: | Version | Date | Author | Summary of Changes | |---------|------------|-------------|--------------------| | 0.1 | xxxx-xx-xx | XXXXXXXXXX | Initial draft | + ::: The `validation` package contains a set of functions to assist in the running and reporting of tests that have been published on the SCTO platform. The tests themselves are located in the [validation_tests](www.github.com/SwissClinicalTrialOrganisation/validation_tests) repository. The results of the tests are then published as issues in the [pkg_validation](www.github.com/SwissClinicalTrialOrganisation/pkg_validation) repository.