Esc

COMARK0115 · warning

comark/annotate/missing-note

Write a note in every ::annotation

An annotation's content is its note. Without one, the mark has a number and nothing to say, and readers have to guess why it's there.

Incorrect

::screenshot{src="/pond.png" alt="The pond map with three ducks"}
:::annotation{x=20 y=30 w=15 h=10}
:::
::
md
lint-comark example.mdexample.md:1:19 comark/annotate/missing-notescreenshot "/pond.png", annotation 1: write a note explaining what the mark points at.Change the block as the message says.✖ 1 problem

Correct

::screenshot{src="/pond.png" alt="The pond map with three ducks"}
:::annotation{x=20 y=30 w=15 h=10}
The duck without a name tag.
:::
::
md
lint-comark example.md✔ No problems