diff --git a/src/config.rs b/src/config.rs index c84331e..e9c095a 100644 --- a/src/config.rs +++ b/src/config.rs @@ -307,7 +307,6 @@ impl Config { ("imperative", "Rule: use the imperative mood in the description (e.g. \"Fix bug\" instead of \"Fixed bug\")."), ("whitespace", "Rule: disallow leading/trailing whitespace and consecutive spaces."), ("description_case", "Rule: commit description must start with the specified case. Options: \"any\", \"lower\", \"upper\"."), - ("capitalize_description", "Rule: capitalize the first letter of commit descriptions."), ("no_period", "Rule: do not end commit header with a period."), ("max_header_length", "Rule: limit the header to the specified length. A value of 0 disables this rule."), ("max_body_length", "Rule: wrap the body at the specified length. A value of 0 disables this rule."), diff --git a/website/docs/examples.md b/website/docs/examples.md index 35dbeac..c1c6a5c 100644 --- a/website/docs/examples.md +++ b/website/docs/examples.md @@ -14,8 +14,8 @@ To follow his advice, you can use the following configuration: # Process each non-empty line in the commit message as an individual commit. split_lines = false -# Rule: capitalize the first letter of commit descriptions. -capitalize_description = true +# Rule: commit description must start with the specified case. Options: "any", "lower", "upper". +description_case = "upper" # Rule: use the imperative mood in the description (e.g. "Fix bug" instead of "Fixed bug"). imperative = true diff --git a/website/docs/usage.md b/website/docs/usage.md index 5bdae70..f691794 100644 --- a/website/docs/usage.md +++ b/website/docs/usage.md @@ -55,8 +55,6 @@ Read the [rules documentation](/docs/rules) for more information. Disallow leading/trailing whitespace and consecutive spaces [env: GIT_SUMI_WHITESPACE=] -E, --description-case Commit description must start with the selected case. Options: "lower", "upper", "any". Default: "any" [env: GIT_SUMI_DESCRIPTION_CASE=] --D, --capitalize-description - Capitalize the first letter of commit descriptions [env: GIT_SUMI_CAPITALIZE_DESCRIPTION=] -P, --no-period Do not end commit header with a period [env: GIT_SUMI_NO_PERIOD=] -H, --max-header-length