Skip to content

maint/check-keywords-documented doesn't understand !376's divs

It should at least check them.

Perhaps it should be able to generate them, since it can parse heading lines (and we have a rule - unwritten, but enforced - that the heading lines have to indicate all the keywords covered).

Consequences of missing this check is that it is possible to have:

  1. Missing <div>s. Not a problem until you try to reference them, at which point the link cross reference check will catch it.
  2. Misplaced <div>s. Not sure how likely this is; the placement of these divs is a bit odd maybe? Consequences would be that links would go to the wrong place.
  3. Misspelled <div>s that don't match the actual keyword spelling. Seems unlikely to survive long.

So this doesn't seem like a huge priority. However, we are missing out on an opportunity:

  1. If maint/check-keywords-documented understood this, it could maintain these divs itself automatically.