Skip to content

Commit 1ab52c6

Browse files
committed
[automated] Update nf-core/tools API docs for dev
1 parent 558068a commit 1ab52c6

3 files changed

Lines changed: 7 additions & 4 deletions

File tree

sites/docs/src/content/api_reference/dev/api/pipelines/sync.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ Whether to try to automatically make a PR on GitHub.com
5454

5555
#### `required_config_vars{:python}`
5656

57-
List of nextflow variables required to make template pipeline
57+
Nextflow config variables required to make template pipeline, keyed by section
5858

5959
- **Type:**
60-
list
60+
dict
6161

6262
#### `gh_username{:python}`
6363

sites/docs/src/content/api_reference/dev/api/utils.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Class to provide a single session for interacting with the GitHub API for a run.
1010
Inherits the requests_cache.CachedSession and adds additional functionality,
1111
such as automatically setting up GitHub authentication if we can.
1212

13-
#### `get(url, **kwargs){:python}`
13+
#### `get(url, params=None, **kwargs){:python}`
1414

1515
Initialise the session if we haven’t already, then call the superclass get method.
1616

@@ -473,7 +473,7 @@ Validator for file path specified as –singularity-cache-index argument in nf-c
473473

474474
#### `_abc_impl{:python}`_= <\_abc.\_abc_data object>_
475475

476-
#### `validate(value){:python}`
476+
#### `validate(document) → None{:python}`
477477

478478
Validate the input.
479479
If invalid, this should raise a `ValidationError`.

sites/docs/src/content/api_reference/dev/module_lint_tests/main_nf.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ in which case failures will be reported as warnings.
99

1010
The following checks are performed:
1111

12+
- `main_nf_module_granularity`: The module must represent a single command
13+
as `<tool>` or single subcommand with distinct functionality as
14+
`<tool/subtool>`.
1215
- `main_nf_exists`: The `main.nf` file must exist.
1316
- `deprecated_dsl2`: The file must not contain deprecated DSL2 identifiers
1417
(`initOptions`, `saveFiles`, `getSoftwareName`, `getProcessName`,

0 commit comments

Comments
 (0)