Skip to content

Fix workflow catalog table and revise documentation - #3

Draft
dgruano wants to merge 2 commits into
chore/hooksfrom
dani/docs
Draft

Fix workflow catalog table and revise documentation#3
dgruano wants to merge 2 commits into
chore/hooksfrom
dani/docs

Conversation

@dgruano

@dgruano dgruano commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

What & why

The Snakemake workflow catalog automatically parses the config.schema.yaml to build a parameter table. However, our current release breaks the table in the middle:

image

This happens right after the description field of atera parameters. Indeed, the problem is caused by the block chomping indicator (i.e. the little > before the long, multiline description). Starting the description with > leaves a trailing newline character that is parsed by snakemake inside the table, which breaks the formatting. Instead, >- should fix the parsing. We won't know for sure until we merge to main and release to the catalog, but should work.

Otherwise, I also include small doc changes that fix typos or improve readability. Feel free to chip in.

Opening as a stacked PR onto #2 and leaving it as a draft for now, as I may add new modifications

Validation

  • mkdocs build --strict passes, if documentation was changed

@dgruano dgruano self-assigned this Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant