Skip to content

Improve output of vale substitution rule

Marcel Amirault requested to merge docs-update-vale-since-rule into master

What does this MR do?

As raised in the linked issue, the message for since is not clear, as the suggestion could be because, or it could be after, depending on the usage of since.

As an MVC/POC, I've changed the message so that it outputs both because and after as possible solutions. As a result, the double quotes have to be moved from the message text, to the individual rule lines, but it seems to work properly:

  • Screen_Shot_2020-12-01_at_10.38.07
  • Screen_Shot_2020-12-01_at_10.38.19

Related issues

Resolves #273619 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports