terminology.preferred-form

Rationale

The entry owns the relationship between a recognized surface and its unique canonical spelling, so replacement does not require guessing meaning.

Guidance

Replace the captured authored form with the canonical name supplied by the same Canon entry.

Checker behavior

Message

Use {suggested} instead of {captured}.

Applies in

• heading
• body
• blockquote
• list item
• table cell
• json key
• glossary term
• notation token

Detection

kind

term

relations

• deprecated_forms
• preferred_over

Authored examples and fix policies

subtypes

[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "canonical-bond",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Bond"
        }
      ],
      "incorrect": [
        {
          "captured": "connection capacity",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "preferred-bond",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Bond",
          "surface": "docs",
          "text": "connection capacity"
        }
      ]
    },
    "id": "preferred-over",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "path"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "canonical-modulating",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Modulating"
        }
      ],
      "incorrect": [
        {
          "captured": "Cooling",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "path"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "deprecated-cooling",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Modulating",
          "surface": "docs",
          "text": "Cooling"
        }
      ]
    },
    "id": "deprecated-form",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  }
]