From 6aba845bc79b60854252db7d327d17e97454c5da Mon Sep 17 00:00:00 2001 From: Lukas Forer Date: Thu, 13 Jun 2024 16:01:16 +0200 Subject: [PATCH] Add basic documentation --- docs/docs/cli/coverage.md | 19 +++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 20 insertions(+) create mode 100644 docs/docs/cli/coverage.md diff --git a/docs/docs/cli/coverage.md b/docs/docs/cli/coverage.md new file mode 100644 index 00000000..2d29f111 --- /dev/null +++ b/docs/docs/cli/coverage.md @@ -0,0 +1,19 @@ +# `coverage` command + +:octicons-tag-24: 0.9.0 + +## Usage + +``` +nf-test coverage +``` + +The `coverage` command prints information about the number of Nextflow files that are covered by a test. + +### Optional Arguments + +#### `--csv ` +Writes a coverage report in csv format. + +#### `--html ` +Writes a coverage report in html format. diff --git a/mkdocs.yml b/mkdocs.yml index 29829fd3..9667650f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,7 @@ nav: - generate: docs/cli/generate.md - test: docs/cli/test.md - list: docs/cli/list.md + - coverage: docs/cli/coverage.md - clean: docs/cli/clean.md - Configuration: docs/configuration.md - Plugins: