diff options
| author | Rémy Coutable <remy@rymai.me> | 2016-10-13 20:35:57 +0300 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2016-10-13 20:35:57 +0300 |
| commit | c1dd1795ed57c9481a1a9cab81daef39dd218346 (patch) | |
| tree | 6c8b88ec46257b1db9835e90bbb0f52951fa3e0b /doc/development/doc_styleguide.md | |
| parent | b2c771f45261e1484158d1304cd898e866002f07 (diff) | |
Move the Grape DSL part from Doc styleguide to API styleguide
Also improve API styleguide
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc/development/doc_styleguide.md')
| -rw-r--r-- | doc/development/doc_styleguide.md | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 0b725cf200c..882da2a6562 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -342,12 +342,6 @@ You can use the following fake tokens as examples. Here is a list of must-have items. Use them in the exact order that appears on this document. Further explanation is given below. -- Every method must be described using [Grape's DSL](https://github.com/ruby-grape/grape/tree/v0.13.0#describing-methods) - (see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/environments.rb - for a good example): - - `desc` for the method summary (you can pass it a block for additional details) - - `params` for the method params (this acts as description **and** validation - of the params) - Every method must have the REST API request. For example: ``` |