Skip to content

docs: rework coverage regex examples to work around a markdown escaping issue with the nyc example

What does this MR do?

Code coverage regex example for nyc (NodeJS) rendered badly from markdown in self-hosted GitLab help and in the repo preview as well (see https://gitlab.com/gitlab-org/gitlab/-/blob/3dd4985454e2308ac3aa77444e46ffbd0bfe5e16/doc/ci/pipelines/settings.md). Online html docs on the opposite shows the regexp correctly.

This is due to missing escape for | character within the table which this MR attempt to fix. Moreover literal \ should be escaped as well to show up.

Related issues

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 Andrea Galbusera

Merge request reports