search

ratt-ru / tricolour

Holds an offline, MS direct version of the SDP online flagger.
Other
8 stars 4 forks source link

Documentation #46

Open sjperkins opened 5 years ago

sjperkins commented 5 years ago

At the moment, the documentation is in the main README.rst and is sorely out of date.

  1. The strategies are now explicitly ordered as a yaml list.
  2. The iisted commandline arguments are out of date.

To solve (1) I think each strategy and it's parameters should be documented in Restructured Text.

To solve (2) I think the user should just be instructed to tricolour --help as its always going to be difficult to keep the docs and command line args up to date.

KshitijT commented 4 years ago

Is the documentation available somewhere now?

bennahugo commented 4 years ago

not externally. --help should give you a reasonable idea of what options are available.

The rest is quite extensively documented in the code: https://github.com/ska-sa/tricolour/blob/master/tricolour/flagging.py