Define CLI option descriptions consistently

jekyll / jekyll-import

:inbox_tray: The "jekyll import" command for importing from various blogs to Jekyll format.

https://import.jekyllrb.com

MIT License

515 stars 316 forks source link

Define CLI option descriptions consistently #496

Closed ashmaroli closed 1 year ago

ashmaroli commented 1 year ago

Summary

List options with default values after ones that do not.
Terminate sentences with a period.
Mention default values with a consistent pattern (default: ...), at the end of description.
Use double-quotes to delimit strings, optionally single-quotes for substrings.
Align parameters for better readability for humans (opinionated.).

parkr commented 1 year ago

I haven't looked through these yet but I was thinking that we could auto-generate the documentation from these options somehow (in a separate PR). Thanks for cleaning these up!

ashmaroli commented 1 year ago

I was thinking that we could auto-generate the documentation from these options

Yes, we could. I have already developed a vision / idea locally. I found current docs theme off-putting so came up with my own opinionated design to suit the local development.

parkr commented 1 year ago

@jekyllbot: merge +docs