LectureCut needs to be upfront with how to use it.
This includes
updating the README and
updating the argparse help text(s).
README
The README should reflect all the existing flags / arguments, how to use them and what the default value is.
There should also be some examples and the corresponding output.
Argparse help text(s)
Currently, the argparse help texts are Copilot generated and thus a bit crude and not 100% consistent.
All help texts should have the same format, be completely clear about what they do, and include all possible ways of using them.
The ArgumentParser object should also get a usage segment including a few examples.
LectureCut needs to be upfront with how to use it.
This includes
argparsehelp text(s).README
The README should reflect all the existing flags / arguments, how to use them and what the default value is. There should also be some examples and the corresponding output.
Argparse help text(s)
Currently, the
argparsehelp texts are Copilot generated and thus a bit crude and not 100% consistent. All help texts should have the same format, be completely clear about what they do, and include all possible ways of using them. The ArgumentParser object should also get ausagesegment including a few examples.