summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgfyoung <gfyoung17@gmail.com>2018-09-29 15:25:28 -0700
committergfyoung <gfyoung17@gmail.com>2018-09-29 15:26:00 -0700
commitf6c02ee0275fca7974d8573b855bc40e94bdedcc (patch)
treedb60439f92812d208ec656b77e597342c5e70713
parent227cc997fb107672e3293c56e0dcb1df72ad82d5 (diff)
downloadgitlab-ce-f6c02ee0275fca7974d8573b855bc40e94bdedcc.tar.gz
Update docs regarding frozen string
xref #47424.
-rw-r--r--changelogs/unreleased/frozen-string-docs.yml5
-rw-r--r--doc/development/performance.md6
2 files changed, 9 insertions, 2 deletions
diff --git a/changelogs/unreleased/frozen-string-docs.yml b/changelogs/unreleased/frozen-string-docs.yml
new file mode 100644
index 00000000000..2eb8a446ee8
--- /dev/null
+++ b/changelogs/unreleased/frozen-string-docs.yml
@@ -0,0 +1,5 @@
+---
+title: Update docs regarding frozen string
+merge_request:
+author: gfyoung
+type: other
diff --git a/doc/development/performance.md b/doc/development/performance.md
index 05caffb150a..c7b10dfd5ce 100644
--- a/doc/development/performance.md
+++ b/doc/development/performance.md
@@ -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