Fix workflow catalog table and revise documentation - #3
Draft
dgruano wants to merge 2 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
The Snakemake workflow catalog automatically parses the
config.schema.yamlto build a parameter table. However, our current release breaks the table in the middle: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 --strictpasses, if documentation was changed