summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Leitzen <peter@leitzen.de>2021-10-18 17:33:04 +0200
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2021-10-30 09:59:59 +0900
commit09bdb43567b0ae3c46180073043136ec8ec0f6a2 (patch)
tree08ed32789f4a0d800587b0c9c0e03542f3a766fd
parentf634d1ee00e8327f1e91a5af3792c0e30c38c330 (diff)
Clarify docs about magic comments placement
Magic comments like `frozen_string_literal` may appear everywhere within the first comment section while `encoding` have to be the first line, or second line after shebang.
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/4985
-rw-r--r--doc/syntax/comments.rdoc6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/syntax/comments.rdoc b/doc/syntax/comments.rdoc
index b361e077b6..dbc7816984 100644
--- a/doc/syntax/comments.rdoc
+++ b/doc/syntax/comments.rdoc
@@ -41,8 +41,7 @@ syntax error:
While comments are typically ignored by Ruby, special "magic comments" contain
directives that affect how the code is interpreted.
-Top-level magic comments must start on the first line, or on the second line if
-the first line looks like <tt>#! shebang line</tt>.
+Top-level magic comments must appear in the first comment section of a file.
NOTE: Magic comments affect only the file in which they appear;
other files are unaffected.
@@ -74,7 +73,8 @@ regexp literals and <code>__ENCODING__</code>:
Default encoding is UTF-8.
-It must appear in the first comment section of a file.
+Top-level magic comments must start on the first line, or on the second line if
+the first line looks like <tt>#! shebang line</tt>.
The word "coding" may be used instead of "encoding".