diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-08-22 08:50:31 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-08-22 08:50:31 +0000 |
commit | d2cb8f785edb6fbc9ce00c39d485423d45c0c219 (patch) | |
tree | 5d81c9f28ed09a4b4763e5b79344d27161294982 /doc/development/api_styleguide.md | |
parent | 7b5708d1d944547dfea9bc8b6b8e1c6c6e22901b (diff) | |
download | gitlab-ce-d2cb8f785edb6fbc9ce00c39d485423d45c0c219.tar.gz |
Update docs to pass new markdownlint
Deletes extra spaces and line, makes lists consistent, and
fixes links.
Diffstat (limited to 'doc/development/api_styleguide.md')
-rw-r--r-- | doc/development/api_styleguide.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 0866d3baeeb..61576236c96 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -51,7 +51,7 @@ allowed. – <https://github.com/ruby-grape/grape#declared> -### Exclude params from parent namespaces! +### Exclude params from parent namespaces > By default `declared(params)`includes parameters that were defined in all parent namespaces. @@ -64,7 +64,7 @@ In most cases you will want to exclude params from the parent namespaces: declared(params, include_parent_namespaces: false) ``` -### When to use `declared(params)`? +### When to use `declared(params)` You should always use `declared(params)` when you pass the params hash as arguments to a method call. |