Skip to content

Commit

Permalink
📝 docs: remove references to capitalize_description
Browse files Browse the repository at this point in the history
Rule was superseded by `description_case`.
  • Loading branch information
welpo committed Feb 5, 2024
1 parent 0a08d30 commit c2a3044
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 5 deletions.
1 change: 0 additions & 1 deletion src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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."),
Expand Down
4 changes: 2 additions & 2 deletions website/docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions website/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 <MAX_HEADER_LENGTH>
Expand Down

0 comments on commit c2a3044

Please sign in to comment.