Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Guidelines
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Redmine
Redmine
Labels
Merge Requests
1
Merge Requests
1
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
External
Guidelines
Commits
5d60cfdc
Verified
Commit
5d60cfdc
authored
May 02, 2018
by
Lukáš Pokorný
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
user YARD for doc, if you want doc something...
Signed-off-by:
Lukáš Pokorný
<
lukas.pokorny@easysoftware.cz
>
parent
364466f6
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
1 deletion
+3
-1
DEV/CODE_STYLE.md
DEV/CODE_STYLE.md
+3
-1
No files found.
DEV/CODE_STYLE.md
View file @
5d60cfdc
...
...
@@ -64,7 +64,7 @@ Comments are required on complex code. Otherwise you should write _self-labeling
```
ruby
# BAD
def
convert_date
(
project
,
issue
,
user
,
date
,
**
options
)
...
#
...
end
# GOOD
...
...
@@ -73,6 +73,8 @@ def render_user_name(user)
end
```
In general, comments are welcome. Please use
[
YARD
](
https://yardoc.org
)
docs style only.
**Quotes**
On Ruby single quotes is preferred.
...
...
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