Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

snakemake-style-guide: Recommend *raw* triple-quoted strings for shell blocks #221

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

tsibley
Copy link
Member

@tsibley tsibley commented Aug 15, 2024

This greatly enhances the readability of the shell block in Snakemake's log messages and avoids accidentally interpreting escapes too early.

Checklist

@tsibley
Copy link
Member Author

tsibley commented Aug 15, 2024

Before

image

After

image

@tsibley tsibley requested a review from a team August 15, 2024 18:03
Copy link
Member

@victorlin victorlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good improvement.

src/reference/snakemake-style-guide.rst Outdated Show resolved Hide resolved
…l blocks

This greatly enhances the readability of the shell block in Snakemake's
log messages and avoids accidentally interpreting escapes too early.
@tsibley tsibley force-pushed the trs/snakemake-style-guide/raw-shell-blocks branch from 0b99a99 to 9c81017 Compare August 20, 2024 19:21
@tsibley tsibley merged commit b571af8 into master Aug 20, 2024
3 of 4 checks passed
@tsibley tsibley deleted the trs/snakemake-style-guide/raw-shell-blocks branch August 20, 2024 19:22
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.

5 participants