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
Do you want to keep the short and informal list of modules, or should we switch to listing modules together with their module --help output after switching everything to using clap?
The text was updated successfully, but these errors were encountered:
Some context for my answer: one hope I have for this project is to do gigs with medium sized groups of performers, not limited to people with programming experience.
With that in mind, I'd like there to be a place where the modules are described using non-specialised language (with a focus on the audible result) and with very simple use instructions. I realise while this repo is acting as the sole source of all earwig info we may be fighting contradictory goals (dev friendly docs vs. user friendly docs) but maybe there is a path for now where we don't end up with too much duplication.
Having a consistent layout (as clap docs gives us) is great though, how about:
We switch to clap style docs as you drafted
We keep in mind that the module descriptions should try to use non-specialist language (maybe it can even be engaging ;-p)
Any deeper descriptions of how the module works can go in the module itself
Sounds good to me. Also, keep in mind that my investment in this project is realistically speaking far lower than yours, so I wouldn't mind at all if you simply overruled me on issues like this.
Do you want to keep the short and informal list of modules, or should we switch to listing modules together with their
module --help
output after switching everything to usingclap
?The text was updated successfully, but these errors were encountered: