You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Though it is nice to see the --help output in the README, it shouldn't go there since if the CLI output info changes, you often forget to update the README, and then your docs are inaccurate. You forget to add new options, update, etc. https://nf-co.re/docs/usage/introduction has some examples on how to build documentation automatically (for things like readthedocs) that come from your CLI stuff. So you reduce the number of places it comes from. You update it in as few of places as possible so your docs don't get out of date.
The text was updated successfully, but these errors were encountered:
Though it is nice to see the
--help output
in the README, it shouldn't go there since if the CLI output info changes, you often forget to update the README, and then your docs are inaccurate. You forget to add new options, update, etc. https://nf-co.re/docs/usage/introduction has some examples on how to build documentation automatically (for things like readthedocs) that come from your CLI stuff. So you reduce the number of places it comes from. You update it in as few of places as possible so your docs don't get out of date.The text was updated successfully, but these errors were encountered: