Merge branch 'frozen-string-docs' into 'master'

Update docs regarding frozen string

See merge request gitlab-org/gitlab-ce!22003
This commit is contained in:
Rémy Coutable 2018-10-01 11:50:01 +00:00
commit 39d2f186a7
2 changed files with 9 additions and 2 deletions

View File

@ -0,0 +1,5 @@
---
title: Update docs regarding frozen string
merge_request:
author: gfyoung
type: other

View File

@ -364,8 +364,7 @@ Depending on the size of the String and how frequently it would be allocated
there's no guarantee it will.
Strings will be frozen by default in Ruby 3.0. To prepare our code base for
this eventuality, it's a good practice to add the following header to all
Ruby files:
this eventuality, we will be adding the following header to all Ruby files:
```ruby
# frozen_string_literal: true
@ -379,6 +378,9 @@ test = +"hello"
test += " world"
```
When adding new Ruby files, please check that you can add the above header,
as omitting it may lead to style check failures.
## Anti-Patterns
This is a collection of [anti-patterns][anti-pattern] that should be avoided