composition rule

composition.harmony

Compose one capacity and one domain into the asserted harmony member.

  • product: error
  • marketing: error
  • public: warning
  • docs: warning

Rationale

No separate rationale is authored; the rule statement above is authoritative.

Guidance

No separate guidance is authored. The rule's authored examples and fix policies follow below.

Checker behavior

Message

{captured} is not a valid Canon composition.

Applies in

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

Detection

detector
composition.harmony
kind
delegated

Authored examples and fix policies

subtypes
[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "attempt": {
                "capacity": "F",
                "composition_id": "compose.harmony",
                "domain": "M"
              },
              "components": [
                {
                  "end": 2,
                  "role": "capacity",
                  "start": 0
                },
                {
                  "end": 2,
                  "role": "domain",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-operands-valid",
          "profile": "general-prose",
          "surface": "docs",
          "text": "FM"
        }
      ],
      "incorrect": [
        {
          "captured": "MM",
          "check_input": {
            "expectation": {
              "attempt": {
                "capacity": "M",
                "composition_id": "compose.harmony",
                "domain": "M"
              },
              "components": [
                {
                  "end": 2,
                  "role": "capacity",
                  "start": 0
                },
                {
                  "end": 2,
                  "role": "domain",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-wrong-operand-kind",
          "outcome_id": "violation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "MM"
        }
      ]
    },
    "id": "operand-kind",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "attempt": {
                "capacity": "F",
                "composition_id": "compose.harmony",
                "domain": "M",
                "member_id": "harmony.acuity"
              },
              "components": [
                {
                  "end": 2,
                  "role": "capacity",
                  "start": 0
                },
                {
                  "end": 2,
                  "role": "domain",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-member-valid",
          "profile": "general-prose",
          "surface": "docs",
          "text": "FM"
        }
      ],
      "incorrect": [
        {
          "captured": "FM",
          "check_input": {
            "expectation": {
              "attempt": {
                "capacity": "F",
                "composition_id": "compose.harmony",
                "domain": "M",
                "member_id": "harmony.embrace"
              },
              "components": [
                {
                  "end": 2,
                  "role": "capacity",
                  "start": 0
                },
                {
                  "end": 2,
                  "role": "domain",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-member-mismatch",
          "outcome_id": "violation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "FM"
        }
      ]
    },
    "id": "member",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  }
]