summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2016-10-13 19:40:20 +0200
committerRémy Coutable <remy@rymai.me>2016-10-13 19:40:20 +0200
commitb4810fd2bce42d66cada56af3ef697219f176b87 (patch)
treefcaa93265e7b3d2d8458bbe29053036212e03245
parent3a1d9bccd6c3ce8249e90153f4299db1c037eb56 (diff)
downloadgitlab-ce-b4810fd2bce42d66cada56af3ef697219f176b87.tar.gz
More improvements
Signed-off-by: Rémy Coutable <remy@rymai.me>
-rw-r--r--doc/development/api_styleguide.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md
index 94047dfe173..2a41314d2db 100644
--- a/doc/development/api_styleguide.md
+++ b/doc/development/api_styleguide.md
@@ -22,8 +22,8 @@ for a good example):
- The GitLab version when the endpoint was added
- If the endpoint is deprecated, and if yes when will it be removed
-- `params` for the method params. This acts as description, validation, and
- coercion of the parameters
+- `params` for the method params. This acts as description,
+ [validation, and coercion of the parameters]
A good example is as follows:
@@ -93,4 +93,4 @@ Model.create(foo: params[:foo])
```
[Entity]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/entities.rb
-[parameters validation and coercion]: https://github.com/ruby-grape/grape#parameter-validation-and-coercion
+[validation, and coercion of the parameters]: https://github.com/ruby-grape/grape#parameter-validation-and-coercion