search

rajewsky-lab / mirdeep2

Discovering known and novel miRNAs from small RNA sequencing data
GNU General Public License v3.0
135 stars 49 forks source link

Incorrect script reference in README #94

Closed mschilli87 closed 2 years ago

mschilli87 commented 2 years ago

The quantifier module script reference section of the current README contains an incorrect list of options. A quick git blame revealed that this seems to be the case for over ten years already. Maybe we should just update the reference of all scripts to catch additional issues like this before the next release?

Drmirdeep commented 2 years ago

The quantifier.pl in the Readme is updated. However, since no one ever sent a message I guess no one ever looked into it. Also, just calling a script without parameters or -h will show the usage on the screen.

mschilli87 commented 2 years ago

Should we then remove the documentation from the README and point to -h for all scipts instead? I guess no documentation would be better than wrong documentation. :wink:

Drmirdeep commented 2 years ago

If you tell me (or MR 'no one') where the documentation is wrong then it can be corrected (and only if it bothers MR 'no one').