readme_wrong_title

Category

Style

Severity

Warning

What It Does

Checks that the first line in the README.md contains the symbol for title at the beginning followed by $STATE_TYPE.$FORMULA_NAME.

Why Is This Bad

Wrongly named readmes can be confusing and can look weird in the documentation.

How To Fix

Put a correctly formatted line as the first line of the readme that is affected.

Known Problems

None

Example

Example README.md from formula.nginx

# formula.not_nginx

Manage nginx webserver.
error: README.md of formula `formula.nginx` does not start with formula name heading
  file: "states/formula/nginx/README.md"
  line: 1:1 to 22:1
  quickfix: put `# formula.nginx` as first line in file "states/formula/nginx/README.md"
  category: Style
  help: for more information see https://share.thaller.ws/sk43iJjWGQoypYQB2JtopK5KnLwa9u/index.html#formula_readme_wrong_title

results matching ""

    No results matching ""