Skip to content

Propose a may / might / can Vale rule

Amy Qualls requested to merge aqualls-may-might-can into master

What does this MR do?

We have a rule for may / might / can usage (https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#may-might) that I forgot about, and @msedlakjakubowski caught in !123571 (comment 1430817829) earlier today. I spent a few minutes thinking about how to build a rule to discourage usage of may. This idea is a bit of a blunt instrument, but based on my reading of the rule, we're tacitly discouraging may in favor of either might or can:

Might means something has the probability of occurring. May gives permission to do something. Consider can instead of may.

The down side: 1889 hits for this rule. I suppose the silver lining is that I'm not the only one bobbling this usage? Rather than doing an expandable section for the results, I'll just attach a file.

I've proposed this at the suggestion level, given its frequency in the docset. I'm sending over to @dianalogan and @kpaizee for transparency while Suzanne is on PTO.

MayMightCan.md

Related issues

Author's checklist

If you are a GitLab team member and 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.

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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.
Edited by Amy Qualls

Merge request reports