user YARD for doc, if you want doc something...

Signed-off-by: Lukáš Pokorný's avatarLukáš Pokorný <lukas.pokorny@easysoftware.cz>
parent 364466f6
......@@ -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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment