gitlab-org--gitlab-foss/doc/development/newlines_styleguide.md

109 lines
1.3 KiB
Markdown
Raw Normal View History

---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
# Newlines style guide
2016-08-03 05:26:24 -04:00
This style guide recommends best practices for newlines in Ruby code.
## Rule: separate code with newlines only to group together related logic
2016-08-03 05:26:24 -04:00
```ruby
# bad
def method
issue = Issue.new
issue.save
render json: issue
2016-08-03 05:26:24 -04:00
end
```
```ruby
# good
def method
issue = Issue.new
issue.save
render json: issue
2016-08-03 05:26:24 -04:00
end
```
## Rule: separate code and block with newlines
### Newline before block
```ruby
# bad
def method
issue = Issue.new
if issue.save
render json: issue
end
end
```
```ruby
# good
def method
issue = Issue.new
if issue.save
render json: issue
end
end
```
## Newline after block
```ruby
# bad
def method
if issue.save
issue.send_email
end
render json: issue
end
```
```ruby
# good
def method
if issue.save
issue.send_email
end
render json: issue
end
```
### Exception: no need for newline when code block starts or ends right inside another code block
```ruby
# bad
def method
if issue
if issue.valid?
issue.save
end
end
end
```
```ruby
# good
def method
if issue
if issue.valid?
issue.save
end
end
end
```