tfproviderdocs icon indicating copy to clipboard operation
tfproviderdocs copied to clipboard

Document section detection is too greedy

Open gdavison opened this issue 3 years ago • 0 comments

When using -enable-contents-check, the section detector only looks for a match at the start of the section header.

For example, a heading like ## Imported Certificates will trigger an error, even when there's a section ## Import later in the document.

Several possible solutions could be used:

  1. Adding a comment to ignore a rule
  2. Only trigger a header rule if there's no exactly matching header in the document
  3. Content analysis on the body of the section, especially for sections like Import which have a standard format

gdavison avatar Sep 28 '22 20:09 gdavison