[ruby/prism] Fix up rdoc

Fixes ruby/prism#2572

ruby/prism@a446580e75

Author: kddnewton

lib/prism/translation/ripper.rb

@@ -19,31 +19,31 @@ module Translation
     # The main known difference is that we may omit dispatching some events in
     # some cases. This impacts the following events:
     #
-    # * on_assign_error
-    # * on_comma
-    # * on_ignored_nl
-    # * on_ignored_sp
-    # * on_kw
-    # * on_label_end
-    # * on_lbrace
-    # * on_lbracket
-    # * on_lparen
-    # * on_nl
-    # * on_op
-    # * on_operator_ambiguous
-    # * on_rbrace
-    # * on_rbracket
-    # * on_rparen
-    # * on_semicolon
-    # * on_sp
-    # * on_symbeg
-    # * on_tstring_beg
-    # * on_tstring_end
+    # - on_assign_error
+    # - on_comma
+    # - on_ignored_nl
+    # - on_ignored_sp
+    # - on_kw
+    # - on_label_end
+    # - on_lbrace
+    # - on_lbracket
+    # - on_lparen
+    # - on_nl
+    # - on_op
+    # - on_operator_ambiguous
+    # - on_rbrace
+    # - on_rbracket
+    # - on_rparen
+    # - on_semicolon
+    # - on_sp
+    # - on_symbeg
+    # - on_tstring_beg
+    # - on_tstring_end
     #
     class Ripper < Compiler
       # Parses the given Ruby program read from +src+.
       # +src+ must be a String or an IO or a object with a #gets method.
-      def Ripper.parse(src, filename = "(ripper)", lineno = 1)
+      def self.parse(src, filename = "(ripper)", lineno = 1)
         new(src, filename, lineno).parse
       end
 
@@ -54,22 +54,22 @@ def Ripper.parse(src, filename = "(ripper)", lineno = 1)
       # By default, this method does not handle syntax errors in +src+,
       # use the +raise_errors+ keyword to raise a SyntaxError for an error in +src+.
       #
-      #   require 'ripper'
-      #   require 'pp'
+      #     require "ripper"
+      #     require "pp"
       #
-      #   pp Ripper.lex("def m(a) nil end")
-      #   #=> [[[1,  0], :on_kw,     "def", FNAME    ],
-      #        [[1,  3], :on_sp,     " ",   FNAME    ],
-      #        [[1,  4], :on_ident,  "m",   ENDFN    ],
-      #        [[1,  5], :on_lparen, "(",   BEG|LABEL],
-      #        [[1,  6], :on_ident,  "a",   ARG      ],
-      #        [[1,  7], :on_rparen, ")",   ENDFN    ],
-      #        [[1,  8], :on_sp,     " ",   BEG      ],
-      #        [[1,  9], :on_kw,     "nil", END      ],
-      #        [[1, 12], :on_sp,     " ",   END      ],
-      #        [[1, 13], :on_kw,     "end", END      ]]
+      #     pp Ripper.lex("def m(a) nil end")
+      #     #=> [[[1,  0], :on_kw,     "def", FNAME    ],
+      #          [[1,  3], :on_sp,     " ",   FNAME    ],
+      #          [[1,  4], :on_ident,  "m",   ENDFN    ],
+      #          [[1,  5], :on_lparen, "(",   BEG|LABEL],
+      #          [[1,  6], :on_ident,  "a",   ARG      ],
+      #          [[1,  7], :on_rparen, ")",   ENDFN    ],
+      #          [[1,  8], :on_sp,     " ",   BEG      ],
+      #          [[1,  9], :on_kw,     "nil", END      ],
+      #          [[1, 12], :on_sp,     " ",   END      ],
+      #          [[1, 13], :on_kw,     "end", END      ]]
       #
-      def Ripper.lex(src, filename = "-", lineno = 1, raise_errors: false)
+      def self.lex(src, filename = "-", lineno = 1, raise_errors: false)
         result = Prism.lex_compat(src, filepath: filename, line: lineno)
 
         if result.failure? && raise_errors
@@ -368,17 +368,17 @@ def Ripper.lex(src, filename = "-", lineno = 1, raise_errors: false)
       # returning +nil+ in such cases. Use the +raise_errors+ keyword
       # to raise a SyntaxError for an error in +src+.
       #
-      #   require "ripper"
-      #   require "pp"
+      #     require "ripper"
+      #     require "pp"
       #
-      #   pp Ripper.sexp("def m(a) nil end")
-      #     #=> [:program,
-      #          [[:def,
-      #           [:@ident, "m", [1, 4]],
-      #           [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil, nil, nil, nil]],
-      #           [:bodystmt, [[:var_ref, [:@kw, "nil", [1, 9]]]], nil, nil, nil]]]]
+      #     pp Ripper.sexp("def m(a) nil end")
+      #       #=> [:program,
+      #            [[:def,
+      #             [:@ident, "m", [1, 4]],
+      #             [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil, nil, nil, nil]],
+      #             [:bodystmt, [[:var_ref, [:@kw, "nil", [1, 9]]]], nil, nil, nil]]]]
       #
-      def Ripper.sexp(src, filename = "-", lineno = 1, raise_errors: false)
+      def self.sexp(src, filename = "-", lineno = 1, raise_errors: false)
         builder = SexpBuilderPP.new(src, filename, lineno)
         sexp = builder.parse
         if builder.error?
@@ -397,23 +397,23 @@ def Ripper.sexp(src, filename = "-", lineno = 1, raise_errors: false)
       # returning +nil+ in such cases. Use the +raise_errors+ keyword
       # to raise a SyntaxError for an error in +src+.
       #
-      #   require 'ripper'
-      #   require 'pp'
+      #     require "ripper"
+      #     require "pp"
       #
-      #   pp Ripper.sexp_raw("def m(a) nil end")
-      #     #=> [:program,
-      #          [:stmts_add,
-      #           [:stmts_new],
-      #           [:def,
-      #            [:@ident, "m", [1, 4]],
-      #            [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil]],
-      #            [:bodystmt,
-      #             [:stmts_add, [:stmts_new], [:var_ref, [:@kw, "nil", [1, 9]]]],
-      #             nil,
-      #             nil,
-      #             nil]]]]
+      #     pp Ripper.sexp_raw("def m(a) nil end")
+      #       #=> [:program,
+      #            [:stmts_add,
+      #             [:stmts_new],
+      #             [:def,
+      #              [:@ident, "m", [1, 4]],
+      #              [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil]],
+      #              [:bodystmt,
+      #               [:stmts_add, [:stmts_new], [:var_ref, [:@kw, "nil", [1, 9]]]],
+      #               nil,
+      #               nil,
+      #               nil]]]]
       #
-      def Ripper.sexp_raw(src, filename = "-", lineno = 1, raise_errors: false)
+      def self.sexp_raw(src, filename = "-", lineno = 1, raise_errors: false)
         builder = SexpBuilder.new(src, filename, lineno)
         sexp = builder.parse
         if builder.error?