Skip to content

Commit

Permalink
headers
Browse files Browse the repository at this point in the history
  • Loading branch information
bio-la committed Feb 23, 2024
1 parent 7f4321d commit 5d09c59
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/yaml_docs/useful_info_on_yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ If you're not familiar with the format please check out these useful links:

## How we use YAML files to configure panpipes actions

### How does panpipes read the configuration files?

`panpipes` reads the whole `pipeline.yml` as `PARAMS` at the beginning of each pipeline execution:

Expand All @@ -26,7 +27,7 @@ PARAMS = P.get_parameters(

```

### 1. Understanding indentations
### Understanding mapping blocks and indentations

YAML works with mapping blocks, which are started and closed by a new indentation level.
Therefore, the indentations in the files are essential for the pipeline to understand which are the blocks that it needs to parse correctly.
Expand Down Expand Up @@ -75,9 +76,7 @@ prot:






### Anchors and Scalars


to reuse these params, (for example for WNN) please use anchors (&) and scalars (*) in the relevant place
Expand Down

0 comments on commit 5d09c59

Please sign in to comment.