root
/
gitlab-ce
mirror of https://gitlab.com/free-releases/gitlab-ce.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Improve copy 

Signed-off-by: Rémy Coutable <remy@rymai.me>
This commit is contained in:
Rémy Coutable 2016-10-17 10:10:13 +02:00
parent b4810fd2bc
commit 11e40c0e26
No known key found for this signature in database
GPG Key ID: 46DF07E5CD9E96AB
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/development/api_styleguide.md
View File

@ -20,7 +20,7 @@ for a good example):
- `desc` for the method summary. You should pass it a block for additional - `desc` for the method summary. You should pass it a block for additional
details such as: details such as:
- The GitLab version when the endpoint was added - 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, - `params` for the method params. This acts as description,
[validation, and coercion of the parameters] [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 `declared(params)` return a `Hashie::Mash` object, on which you will have to
call `.to_h`. 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: For instance: