Commit f6c02ee0 authored by gfyoung's avatar gfyoung

Update docs regarding frozen string

xref #47424.
parent 227cc997
---
title: Update docs regarding frozen string
merge_request:
author: gfyoung
type: other
...@@ -364,8 +364,7 @@ Depending on the size of the String and how frequently it would be allocated ...@@ -364,8 +364,7 @@ Depending on the size of the String and how frequently it would be allocated
there's no guarantee it will. there's no guarantee it will.
Strings will be frozen by default in Ruby 3.0. To prepare our code base for 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 this eventuality, we will be adding the following header to all Ruby files:
Ruby files:
```ruby ```ruby
# frozen_string_literal: true # frozen_string_literal: true
...@@ -379,6 +378,9 @@ test = +"hello" ...@@ -379,6 +378,9 @@ test = +"hello"
test += " world" 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 ## Anti-Patterns
This is a collection of [anti-patterns][anti-pattern] that should be avoided This is a collection of [anti-patterns][anti-pattern] that should be avoided
......
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