Add warnings for split inline code
What does this MR do?
As requested due to the related MR, this is a minimal test for broken inline code spans. It has false positives and does not catch cases where there are multiple inline code spans in a single line, because it's just looking for lines where there is a single backtick (`
) which suggests that the closing backtick is missing.
Known false positives:
- https://gitlab.com/gitlab-org/gitlab/-/blob/bc0a1f7b48324a35cba9d63ba3e40944d3481795/doc/development/fe_guide/style/vue.md#L206-216
- https://gitlab.com/gitlab-org/gitlab/-/blob/bc0a1f7b48324a35cba9d63ba3e40944d3481795/doc/development/testing_guide/frontend_testing.md#L999-1003 (and others of a similar style on that page)
-
https://gitlab.com/gitlab-org/gitlab/-/blob/bc0a1f7b48324a35cba9d63ba3e40944d3481795/doc/user/project/remote_development/connect_machine.md#L108 (
<kbd>`</kbd>
)
Related issues
- Related to !148705 (merged)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.