diff options
author | Evan Read <eread@gitlab.com> | 2019-01-24 09:52:33 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-01-24 09:52:33 +0300 |
commit | c2c2d04b3a0d7942edd8c8608f6bd25428131fc3 (patch) | |
tree | 361f2da1a8509a669bec9887abe65252afea5ac2 /doc/development/api_styleguide.md | |
parent | 7d11049237cca35307b996dcec683693794c831a (diff) |
Fix most instances of bare URLs in markdown
Diffstat (limited to 'doc/development/api_styleguide.md')
-rw-r--r-- | doc/development/api_styleguide.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index ce444ebdde4..4fc38a460f8 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -14,7 +14,7 @@ Always use an [Entity] to present the endpoint's payload. ## Methods and parameters description Every method must be described using the [Grape DSL](https://github.com/ruby-grape/grape#describing-methods) -(see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/environments.rb +(see <https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/api/environments.rb> for a good example): - `desc` for the method summary. You should pass it a block for additional @@ -49,14 +49,14 @@ end `params` block. It filters out the params that have been passed, but are not allowed. -– https://github.com/ruby-grape/grape#declared +– <https://github.com/ruby-grape/grape#declared> ### Exclude params from parent namespaces! > By default `declared(params) `includes parameters that were defined in all parent namespaces. -– https://github.com/ruby-grape/grape#include-parent-namespaces +– <https://github.com/ruby-grape/grape#include-parent-namespaces> In most cases you will want to exclude params from the parent namespaces: |