Format example code

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.51.1
+- Format example code
+
 ## 0.51.0 - January 19, 2025
 - Resolve self in yieldself tags
 - Include absolute paths in config (#674)

lib/solargraph/pin/method.rb

@@ -130,11 +130,7 @@ def documentation
           end
           @documentation += "\n\n" unless @documentation.empty?
           @documentation += "Visibility: #{visibility}"
-          example_tags = docstring.tags(:example)
-          unless example_tags.empty?
-            @documentation += "\n\nExamples:\n\n"
-            @documentation += example_tags.map(&:text).join("\n")
-          end
+          concat_example_tags
         end
         @documentation.to_s
       end
@@ -335,6 +331,18 @@ def parse_overload_param(name)
           [name, :arg]
         end
       end
+
+      def concat_example_tags
+        example_tags = docstring.tags(:example)
+        return if example_tags.empty?
+        @documentation += "\n\nExamples:\n\n```ruby\n"
+        @documentation += example_tags.map do |tag|
+          (tag.name ? "# #{tag.name}\n" : '') +
+            "#{tag.text}\n"
+        end
+        .join("\n")
+        .concat("```\n")
+      end
     end
   end
 end

lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.51.0'
+  VERSION = '0.51.1'
 end