Skip to content

Remove future tense from admonition

Problem to solve

The Dynamic Application Security Testing (DAST) page includes an admonition which uses the phrase "won't show" twice. The GitLab documentation style guide states that the future tense is to be avoided.

Further details

The admonition contains the following text:

Note: A pipeline may consist of multiple jobs, including SAST and DAST scanning. If any job fails to finish for any reason, the security dashboard won’t show DAST scanner output. For example, if the DAST job finishes but the SAST job fails, the security dashboard won’t show DAST results. The analyzer will output an exit code on failure.

Proposal

Replace the two instances of future tense with present tense.

Who can address the issue

Any documentation contributor.

Other links/references

N/A