Back to all reviewers

Consistent documentation formatting

hashicorp/terraform
Based on 4 comments
Other

Maintain consistent style in documentation files to improve readability and professionalism. Specifically: 1. **Command references**: Use a consistent format when referring to CLI commands. Prefer either:

Code Style Other

Reviewer Prompt

Maintain consistent style in documentation files to improve readability and professionalism. Specifically:

  1. Command references: Use a consistent format when referring to CLI commands. Prefer either:
    • The explicit format: “The terraform fmt command” (includes both “The” and “command”)
    • The concise format: “terraform fmt:” followed by a description
  2. Punctuation in lists: Follow consistent punctuation rules in bullet lists:
    • Omit periods from incomplete sentences or phrases in bullet lists
    • Include periods only for complete sentences

Example:

# Recommended

- `backend.tf`: Your backend configuration
- `main.tf`: Resource and data source blocks
- `variables.tf`: Variable blocks in alphabetical order

# Instead of

- `backend.tf`: Your backend configuration.
- `main.tf`: Resource and data source blocks.
- `variables.tf`: Variable blocks in alphabetical order.

Consistent documentation formatting ensures that users can quickly scan and comprehend content, while maintaining a professional appearance throughout the codebase.

4
Comments Analyzed
Other
Primary Language
Code Style
Category

Source Discussions