Miscelanous other doc tweaks

* Format code as code
* Nodoc some missed methods
* Fix method reference

Author: Earlopain

lib/prism/desugar_compiler.rb

@@ -254,137 +254,137 @@ def desugar # :nodoc:
   # DesugarCompiler is a compiler that desugars Ruby code into a more primitive
   # form. This is useful for consumers that want to deal with fewer node types.
   class DesugarCompiler < MutationCompiler
-    # @@foo &&= bar
+    # `@@foo &&= bar`
     #
     # becomes
     #
-    # @@foo && @@foo = bar
+    # `@@foo && @@foo = bar`
     def visit_class_variable_and_write_node(node)
       node.desugar
     end
 
-    # @@foo ||= bar
+    # `@@foo ||= bar`
     #
     # becomes
     #
-    # defined?(@@foo) ? @@foo : @@foo = bar
+    # `defined?(@@foo) ? @@foo : @@foo = bar`
     def visit_class_variable_or_write_node(node)
       node.desugar
     end
 
-    # @@foo += bar
+    # `@@foo += bar`
     #
     # becomes
     #
-    # @@foo = @@foo + bar
+    # `@@foo = @@foo + bar`
     def visit_class_variable_operator_write_node(node)
       node.desugar
     end
 
-    # Foo &&= bar
+    # `Foo &&= bar`
     #
     # becomes
     #
-    # Foo && Foo = bar
+    # `Foo && Foo = bar`
     def visit_constant_and_write_node(node)
       node.desugar
     end
 
-    # Foo ||= bar
+    # `Foo ||= bar`
     #
     # becomes
     #
-    # defined?(Foo) ? Foo : Foo = bar
+    # `defined?(Foo) ? Foo : Foo = bar`
     def visit_constant_or_write_node(node)
       node.desugar
     end
 
-    # Foo += bar
+    # `Foo += bar`
     #
     # becomes
     #
-    # Foo = Foo + bar
+    # `Foo = Foo + bar`
     def visit_constant_operator_write_node(node)
       node.desugar
     end
 
-    # $foo &&= bar
+    # `$foo &&= bar`
     #
     # becomes
     #
-    # $foo && $foo = bar
+    # `$foo && $foo = bar`
     def visit_global_variable_and_write_node(node)
       node.desugar
     end
 
-    # $foo ||= bar
+    # `$foo ||= bar`
     #
     # becomes
     #
-    # defined?($foo) ? $foo : $foo = bar
+    # `defined?($foo) ? $foo : $foo = bar`
     def visit_global_variable_or_write_node(node)
       node.desugar
     end
 
-    # $foo += bar
+    # `$foo += bar`
     #
     # becomes
     #
-    # $foo = $foo + bar
+    # `$foo = $foo + bar`
     def visit_global_variable_operator_write_node(node)
       node.desugar
     end
 
-    # @foo &&= bar
+    # `@foo &&= bar`
     #
     # becomes
     #
-    # @foo && @foo = bar
+    # `@foo && @foo = bar`
     def visit_instance_variable_and_write_node(node)
       node.desugar
     end
 
-    # @foo ||= bar
+    # `@foo ||= bar`
     #
     # becomes
     #
-    # @foo || @foo = bar
+    # `@foo || @foo = bar`
     def visit_instance_variable_or_write_node(node)
       node.desugar
     end
 
-    # @foo += bar
+    # `@foo += bar`
     #
     # becomes
     #
-    # @foo = @foo + bar
+    # `@foo = @foo + bar`
     def visit_instance_variable_operator_write_node(node)
       node.desugar
     end
 
-    # foo &&= bar
+    # `foo &&= bar`
     #
     # becomes
     #
-    # foo && foo = bar
+    # `foo && foo = bar`
     def visit_local_variable_and_write_node(node)
       node.desugar
     end
 
-    # foo ||= bar
+    # `foo ||= bar`
     #
     # becomes
     #
-    # foo || foo = bar
+    # `foo || foo = bar`
     def visit_local_variable_or_write_node(node)
       node.desugar
     end
 
-    # foo += bar
+    # `foo += bar`
     #
     # becomes
     #
-    # foo = foo + bar
+    # `foo = foo + bar`
     def visit_local_variable_operator_write_node(node)
       node.desugar
     end

lib/prism/parse_result.rb

@@ -556,7 +556,7 @@ def inspect # :nodoc:
   # EmbDocComment objects correspond to comments that are surrounded by =begin
   # and =end.
   class EmbDocComment < Comment
-    # This can only be true for inline comments.
+    # Returns false. This can only be true for inline comments.
     def trailing?
       false
     end
@@ -670,9 +670,9 @@ def inspect # :nodoc:
     end
   end
 
-  # This represents the result of a call to ::parse or ::parse_file. It contains
-  # the requested structure, any comments that were encounters, and any errors
-  # that were encountered.
+  # This represents the result of a call to Prism.parse or Prism.parse_file.
+  # It contains the requested structure, any comments that were encounters,
+  # and any errors that were encountered.
   class Result
     # The list of comments that were encountered during parsing.
     attr_reader :comments

lib/prism/pattern.rb

@@ -41,7 +41,7 @@ class Pattern
     class CompilationError < StandardError
       # Create a new CompilationError with the given representation of the node
       # that caused the error.
-      def initialize(repr)
+      def initialize(repr) # :nodoc:
         super(<<~ERROR)
           prism was unable to compile the pattern you provided into a usable
           expression. It failed on to understand the node represented by: