diff options
author | Rémy Coutable <remy@rymai.me> | 2016-10-17 11:10:13 +0300 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2016-10-17 11:10:13 +0300 |
commit | 11e40c0e26e07d153cd2712bf23b5d679b54615c (patch) | |
tree | 143731f1ec6532fdc6f77dec3bbddf1e1fe905dd /doc/development/api_styleguide.md | |
parent | b4810fd2bce42d66cada56af3ef697219f176b87 (diff) |
Improve copy
Signed-off-by: Rémy Coutable <remy@rymai.me>
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 2a41314d2db..ce444ebdde4 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -20,7 +20,7 @@ for a good example): - `desc` for the method summary. You should pass it a block for additional details such as: - The GitLab version when the endpoint was added - - If the endpoint is deprecated, and if yes when will it be removed + - If the endpoint is deprecated, and if so, when will it be removed - `params` for the method params. This acts as description, [validation, and coercion of the parameters] @@ -83,7 +83,7 @@ User.create(declared(params, include_parent_namespaces: false).to_h) `declared(params)` return a `Hashie::Mash` object, on which you will have to call `.to_h`. -But we can use directly `params[key]` when we access single elements. +But we can use `params[key]` directly when we access single elements. For instance: |