Skip to content

Commit

Permalink
[docs] Fix typo.
Browse files Browse the repository at this point in the history
  • Loading branch information
boulund committed Apr 27, 2018
1 parent d462cf4 commit 1e2828f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The documentation for the project is built automatically by
[readthedocs](www.readthedocs.org) upon every commit. The HTML documentation is
available at https://stag-mwc.readthedocs.org. Feel free to improve the
documentation, but avoid committing anything but source documents to the repo.
The documentation is written using Sphix, so all documentation sources are
The documentation is written using Sphinx, so all documentation sources are
written in [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).

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

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

0 comments on commit 1e2828f

Please sign in to comment.