Skip to content

Test for gerunds in SUBheadings

Amy Qualls requested to merge aqualls-heading-gerunds into master

What does this MR do?

Attempts to build a Vale test that looks for gerunds in headings:

  • H1 (page titles) are skipped.
  • H2-H7 are tested.
  • It flags any word in a subheading that ends in ing followed by a word boundary.
  • As currently written, it supports declaring single words as exceptions. ('troubleshooting' is the only addition so far)

Current concerns:

  • Text of message returned
  • The test structure means ignored words are wholly ignored - a gerund is either always right (troubleshooting) or always wrong.
  • Adds about 2000 results.

If it were possible to rewrite the test to capture more text, we might be able to exclude at the phrase level, rather than the word level. That WOULD be a better solution, but I'm not sure it's feasible. I know @sselhorn had concerns about possible false positives, and I'm sure some exist, but we've got so many true positives to clean up first that I think the benefits outweigh the detractions.

Related issues

  • This test stems from guidance merged in !82217 (merged)
  • I've proposed a related subheading test in !82331 (merged) that focuses on identifying overly generic subheadings

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports