lay295 / TwitchDownloader

Twitch VOD/Clip Downloader - Chat Download/Render/Replay
MIT License
2.52k stars 260 forks source link

log-level option is confusing #1127

Closed superbonaci closed 4 days ago

superbonaci commented 4 days ago

Checklist

Edition

Unsure

Describe your issue here

The CLI readme: https://github.com/lay295/TwitchDownloader/blob/master/TwitchDownloaderCLI/README.md#global-arguments

Does not explain if some options include others (like ffmpeg) or each one is independent (which is confusing since programs don't work that way).

For example this could help people know that each one works independently:

--log-level (Default: Status+Info+Warning+Error) Sets the log level flags. Applicable values are: None, Status, Verbose, Info, Warning, Error, Ffmpeg. When None is passed, any other log level flags are ignored and --banner=false is implied.

superbonaci commented 4 days ago

Thanks

ScrubN commented 4 days ago

(Default: Status+Info+Warning+Error)

This is not valid syntax for the crappy argument parser we use.


I'm not sure why I wrote the section on enum flags only to not link to it. It's fixed now.

superbonaci commented 4 days ago

Still it's not clear if Info includes Warning and Error or they offer "separate" information but maybe some software works like that.