Suggestion rulesActive

Include lists

list-usage

Warns, with a single document-level occurrence, when no structured list has been recognized in the text.

Usage of this metric

When enabled and matches are found, the report contains one item with this metric_id in result.suggestions. Absence means no match was found, not that the metric was not evaluated.

Location in the resultresult.suggestions[]metric_id = "list-usage"

Calculation method

Returns a single document-level suggestion, with no text offsets, when has_list is false; has_list is derived from text and structured HTML.

Result interpretation

Each `occurrences` item identifies an affected span. `start` is inclusive and `end` exclusive, both measured in Unicode code points over the submitted text. `replacement`, `alternatives` and `edits` contain values only when a safe change is available. Absence means no match was found, not necessarily that the text is correct.

Limitations

Results depend on plain-text segmentation and recognizable structural markers; the signal alone does not imply a writing error.

Dependencies

language: en
implementation_version: 1.2

Valid example

{
  "category": "discourse",
  "examples": null,
  "explanation": null,
  "id": "sug_1",
  "implementation_version": "1.2",
  "metric_id": "list-usage",
  "metric_title": "Include lists",
  "occurrences": [
    {
      "alternatives": [],
      "edits": [],
      "end": 25,
      "id": "occ_1",
      "paragraph_index": 0,
      "replacement": null,
      "sentence_index": 0,
      "start": 18,
      "text": "example"
    }
  ],
  "recommendations": [
    "Review the detected fragment in context."
  ],
  "severity": "warning",
  "summary": "Example detection returned by this metric."
}

GET /v1/metrics/list-usage

Complete request, response and error contracts, generated automatically from the code.

Open the JSON record