Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define CLI option descriptions consistently #496

Merged
merged 2 commits into from
Dec 10, 2022

Conversation

ashmaroli
Copy link
Member

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
Copy link
Member

parkr commented Nov 28, 2022

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
Copy link
Member Author

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
Copy link
Member

parkr commented Dec 10, 2022

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 144778e into jekyll:master Dec 10, 2022
jekyllbot added a commit that referenced this pull request Dec 10, 2022
github-actions bot pushed a commit that referenced this pull request Dec 10, 2022
Ashwin Maroli: Define CLI option descriptions consistently (#496)

Merge pull request 496
@ashmaroli ashmaroli deleted the consistent-cli-desc branch December 11, 2022 11:12
@jekyll jekyll locked and limited conversation to collaborators Dec 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants