Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
11e40c0e
Commit
11e40c0e
authored
Oct 17, 2016
by
Rémy Coutable
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve copy
Signed-off-by:
Rémy Coutable
<
remy@rymai.me
>
parent
b4810fd2
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
2 additions
and
2 deletions
+2
-2
doc/development/api_styleguide.md
doc/development/api_styleguide.md
+2
-2
No files found.
doc/development/api_styleguide.md
View file @
11e40c0e
...
@@ -20,7 +20,7 @@ for a good example):
...
@@ -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)
...
@@ -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:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment