Add Snakemake style guide #162
Merged
Conversation
This file contains 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
To something less general than "style" so other style guides can be added without confusion.
Copied from the internal wiki¹. ¹ https://nextstrain.atlassian.net/wiki/pages/viewpage.action?pageId=170459138 Co-authored-by: John Huddleston <huddlej@gmail.com>
1 task
tsibley
approved these changes
Jul 25, 2023
There was a problem hiding this comment.
+1 for this!
Let's also deprecate/archive/delete https://github.com/blab/styleguide while we're at it? Once your PR is merged, we can:
- update the nextstrain-builds.md document to link to the page added by your PR: https://docs.nextstrain.org/page/reference/snakemake-style-guide.html
- update the README to say this is unused/never used, and archive the repo (so old links still work)
and then that old repo/guide will finally be cleaned up.
I do think there's a couple things that would be worth porting to the new style guide (the use of :q really should be a no-brainer in our workflows, alas it's not yet), but we can do that in a separate PR.
This is consistent with the existing documentation style guide and a similar Snakemake style guide¹ written by @tsibley. This also allows for the addition of a table of contents, which is done here. I looked into making the section links future-proof to wording changes, however could not find a good solution. The closest is using :ref: roles which adds separately defined links to to the section titles, but those links aren't used by the TOC or header links themselves. ¹ https://github.com/blab/styleguide/blob/6aa5d7aa42acfa97e57a5ee05a4175f158502cac/nextstrain-builds.md
4 tasks
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.
preview of new page
Description of proposed changes
Publish the internal Snakemake style guide as a page on the public docs.
Related issue(s)
This was discussed on Slack [1] [2].
Testing