Skip to content

Commit 1e2828f

Browse files
committed
[docs] Fix typo.
1 parent d462cf4 commit 1e2828f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The documentation for the project is built automatically by
4646
[readthedocs](www.readthedocs.org) upon every commit. The HTML documentation is
4747
available at https://stag-mwc.readthedocs.org. Feel free to improve the
4848
documentation, but avoid committing anything but source documents to the repo.
49-
The documentation is written using Sphix, so all documentation sources are
49+
The documentation is written using Sphinx, so all documentation sources are
5050
written in [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).
5151

5252
### envs
@@ -61,7 +61,8 @@ conda-forge, etc.).
6161
All workflow rules are organized in the `rules` folder. It contains a directory
6262
hierarchy organized by overall function in the workflow, e.g., the subfolder
6363
`taxonomic_profiling` contains rules for all taxonomic profiling tools. It is
64-
recommended to keep one file per logical unit or tool.
64+
recommended to keep one file per logical unit or tool, so they can be easily
65+
toggled by a simple if-statement in the main Snakefile.
6566

6667
The overall concept of StaG-mwc is that analyses are performed on trimmed/cleaned
6768
reads that have had human sequences removed, so rules should generally start

0 commit comments

Comments
 (0)