From: nobu@...
Date: 2017-04-29T05:39:05+00:00
Subject: [ruby-core:80933] [Ruby trunk Feature#13518] Indented multiline	comments

Issue #13518 has been updated by nobu (Nobuyoshi Nakada).


Possible of course, but I'm not a big fan of this.

```diff
diff --git i/misc/ruby-mode.el w/misc/ruby-mode.el
index b1abd18a9e..5e8a6a1646 100644
--- i/misc/ruby-mode.el
+++ w/misc/ruby-mode.el
@@ -135,7 +135,7 @@
   (concat "[?$/%(){}#\"'`.:]\\|<<\\|\\[\\|\\]\\|\\_<\\("
           ruby-block-beg-re
           "\\)\\_>\\|" ruby-block-end-re
-          "\\|^=begin\\|" ruby-here-doc-beg-re)
+          "\\|^[ \t]*=begin\\|" ruby-here-doc-beg-re)
   )
 
 (defconst ruby-negative
@@ -671,8 +671,8 @@ Emacs to Ruby."
             (looking-at "\\.[a-zA-Z_0-9]+")
             (looking-at "\\."))
         (goto-char (match-end 0)))
-       ((looking-at "^=begin")
-        (if (re-search-forward "^=end" end t)
+       ((looking-at "^[ \t]*=begin")
+        (if (re-search-forward "^[ \t]*=end" end t)
             (forward-line 1)
           (setq in-string (match-end 0))
           (goto-char end)))
@@ -954,10 +954,10 @@ An end of a defun is found by moving forward from the beginning of one."
       (cond
        ((looking-at "^\\s *$"))
        ((looking-at "^\\s *#"))
-       ((and (> n 0) (looking-at "^=begin\\>"))
-        (re-search-forward "^=end\\>"))
-       ((and (< n 0) (looking-at "^=end\\>"))
-        (re-search-backward "^=begin\\>"))
+       ((and (> n 0) (looking-at "^[ \t]*=begin\\>"))
+        (re-search-forward "^[ \t]*=end\\>"))
+       ((and (< n 0) (looking-at "^[ \t]*=end\\>"))
+        (re-search-backward "^[ \t]*=begin\\>"))
        (t
         (setq pos (current-indentation))
         (cond
@@ -1410,12 +1410,12 @@ buffer position `limit' or the end of the buffer."
               . ruby-font-lock-syntactic-keywords))))
 
   (defun ruby-font-lock-docs (limit)
-    (if (re-search-forward "^=begin\\(\\s \\|$\\)" limit t)
+    (if (re-search-forward "^[ \t]*=begin\\(\\s \\|$\\)" limit t)
         (let (beg)
           (beginning-of-line)
           (setq beg (point))
           (forward-line 1)
-          (if (re-search-forward "^=end\\(\\s \\|$\\)" limit t)
+          (if (re-search-forward "^[ \t]*=end\\(\\s \\|$\\)" limit t)
               (progn
                 (set-match-data (list beg (point)))
                 t)))))
@@ -1423,12 +1423,12 @@ buffer position `limit' or the end of the buffer."
   (defun ruby-font-lock-maybe-docs (limit)
     (let (beg)
       (save-excursion
-        (if (and (re-search-backward "^=\\(begin\\|end\\)\\(\\s \\|$\\)" nil t)
+        (if (and (re-search-backward "^[ \t]*=\\(begin\\|end\\)\\(\\s \\|$\\)" nil t)
                  (string= (match-string 1) "begin"))
             (progn
               (beginning-of-line)
               (setq beg (point)))))
-      (if (and beg (and (re-search-forward "^=\\(begin\\|end\\)\\(\\s \\|$\\)" nil t)
+      (if (and beg (and (re-search-forward "^[ \t]*=\\(begin\\|end\\)\\(\\s \\|$\\)" nil t)
                         (string= (match-string 1) "end")))
           (progn
             (set-match-data (list beg (point)))
diff --git i/parse.y w/parse.y
index 028b89c070..4d3de062c6 100644
--- i/parse.y
+++ w/parse.y
@@ -7851,6 +7851,18 @@ parse_ident(struct parser_params *parser, int c, int cmd_state)
 }
 
 static int
+parser_indented_bol_p(struct parser_params *parser)
+{
+    const char *p = lex_pbeg;
+    const char *e = lex_p - 1;
+    while (p < e) {
+	if (!ISSPACE(*p)) return FALSE;
+	p++;
+    }
+    return TRUE;
+}
+
+static int
 parser_yylex(struct parser_params *parser)
 {
     register int c;
@@ -8039,7 +8051,7 @@ parser_yylex(struct parser_params *parser)
 	return '!';
 
       case '=':
-	if (was_bol()) {
+	if (was_bol() || parser_indented_bol_p(parser)) {
 	    /* skip embedded rd document */
 	    if (strncmp(lex_p, "begin", 5) == 0 && ISSPACE(lex_p[5])) {
 		int first_p = TRUE;
@@ -8057,6 +8069,7 @@ parser_yylex(struct parser_params *parser)
 			compile_error(PARSER_ARG "embedded document meets end of file");
 			return 0;
 		    }
+		    while (ISSPACE(c)) c = nextc();
 		    if (c != '=') continue;
 		    if (c == '=' && strncmp(lex_p, "end", 3) == 0 &&
 			(lex_p + 3 == lex_pend || ISSPACE(lex_p[3]))) {
diff --git i/test/ruby/test_parse.rb w/test/ruby/test_parse.rb
index 56e1020c5a..a51b5471e4 100644
--- i/test/ruby/test_parse.rb
+++ w/test/ruby/test_parse.rb
@@ -988,6 +988,15 @@
     assert_equal(-100, e.backtrace_locations.first.lineno, bug)
   end
 
+  def test_indented_multiline_comment
+    assert_valid_syntax("#{<<-"begin;"}\n#{<<-"end;"}")
+    begin;
+      =begin
+         <.><^>
+      =end
+    end;
+  end
+
 =begin
   def test_past_scope_variable
     assert_warning(/past scope/) {catch {|tag| eval("BEGIN{throw tag}; tap {a = 1}; a")}}
```


----------------------------------------
Feature #13518: Indented multiline comments
https://bugs.ruby-lang.org/issues/13518#change-64569

* Author: tscheingeld (Terry Scheingeld)
* Status: Open
* Priority: Normal
* Assignee: 
* Target version: 
----------------------------------------
I'd like to submit the idea that multiline comments could be indented. That is, `=begin` and `=end` do not have to start at column zero. That would allow for more flexibility in documenting and commenting code.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>