Improve docs and use markdown

aws · Nov 16, 2024 · 0e206ee · 0e206ee
1 parent 7666be1
commit 0e206ee
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,8 @@
 Gemfile.lock
 gemfiles/*.gemfile.lock
 
+.yardoc/
+doc/
+
 spec/dummy/log/
 spec/dummy/tmp/
diff --git a/.yardopts b/.yardopts
@@ -2,3 +2,4 @@
 --template-path doc-src/templates
 --plugin sitemap
 --hide-api private
+--markup markdown
diff --git a/lib/active_job/queue_adapters/sqs_adapter.rb b/lib/active_job/queue_adapters/sqs_adapter.rb
@@ -4,12 +4,11 @@
 
 module ActiveJob
   module QueueAdapters
-    # == Synchronous adapter for Amazon SQS ActiveJob
-    #
-    # This adapter queues jobs synchronously (ie blocking).
+    # Synchronous adapter for Amazon SQS ActiveJob. This adapter queues jobs synchronously (ie blocking).
     #
     # To use this adapter, set up as:
-    #   config.active_job.queue_adapter = :sqs_async
+    #
+    #     config.active_job.queue_adapter = :sqs_async
     class SqsAdapter
       def enqueue_after_transaction_commit?
         # can be removed after Rails 8

diff --git a/lib/active_job/queue_adapters/sqs_adapter/params.rb b/lib/active_job/queue_adapters/sqs_adapter/params.rb
@@ -3,7 +3,8 @@
 module ActiveJob
   module QueueAdapters
     class SqsAdapter
-      # == build request parameter of Aws::SQS::Client
+      # Build request parameter of Aws::SQS::Client
+      # @api private
       class Params
         class << self
           def assured_delay_seconds(timestamp)

diff --git a/lib/active_job/queue_adapters/sqs_async_adapter.rb b/lib/active_job/queue_adapters/sqs_async_adapter.rb
@@ -5,14 +5,15 @@
 
 module ActiveJob
   module QueueAdapters
-    # == Asynchronous adapter for Amazon SQS ActiveJob
+    # Asynchronous adapter for Amazon SQS ActiveJob This adapter queues jobs asynchronously (ie non-blocking).
     #
-    # This adapter queues jobs asynchronously (ie non-blocking).
     # An error handler can be configured with:
-    #   Aws::ActiveJob::SQS.config.async_queue_error_handler = ->(error, job, send_message_opts) { ... }
+    #
+    #     Aws::ActiveJob::SQS.config.async_queue_error_handler = ->(error, job, send_message_opts) { ... }
     #
     # To use this adapter, set up as:
-    #   config.active_job.queue_adapter = :sqs_async
+    #
+    #     config.active_job.queue_adapter = :sqs_async
     class SqsAsyncAdapter < SqsAdapter
       private