search

MikkelSchubert / paleomix

Pipelines and tools for the processing of ancient and modern HTS data.
https://paleomix.readthedocs.io/en/stable/
MIT License
43 stars 19 forks source link

readthedocs Documentation incorrectly renders double dash with a 'long' single dash #35

Closed jfy133 closed 4 years ago

jfy133 commented 4 years ago

https://paleomix.readthedocs.io/en/latest/bam_pipeline/configuration.html

First instance ( found):

The BAM pipeline exposes a number options, including the maximum number of threads used, and the maximum number of threads used for individual programs, the location of JAR files, and more. These may be set using the corresponding command-line options (e.g. –max-threads). However, it is also possible to set default values for such options, including on a per-host bases. This is accomplished by executing the following command, in order to generate a configuration file at ~/.paleomix/bam_pipeline.ini:

However, source (https://github.com/MikkelSchubert/paleomix/blob/master/docs/bam_pipeline/configuration.rst) correctly shows double dash.

This could be confusing for users who are not familiar with looking for sources of docs.