Commit 3862bcad authored by Jonston Chan's avatar Jonston Chan

Improve documentation example in styleguide

parent 8c5b7e92
......@@ -207,9 +207,9 @@ Some examples fail if incorrect capitalization is used:
Additionally, commands, parameters, values, filenames, and so on must be
included in backticks. For example:
- "Change the `needs` keyword in your `.gitlab.yml`..."
- `needs` is a parameter, and `.gitlab.yml` is a file, so both need backticks.
Additionally, `.gitlab.yml` without backticks fails markdownlint because it
- "Change the `needs` keyword in your `.gitlab-ci.yml`..."
- `needs` is a parameter, and `.gitlab-ci.yml` is a file, so both need backticks.
Additionally, `.gitlab-ci.yml` without backticks fails markdownlint because it
does not have capital G or L.
- "Run `git clone` to clone a Git repository..."
- `git clone` is a command, so it must be lowercase, while Git is the product,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment