Merge pull request #191 from bensheldon/documentation

Add missing YARD docs and Dashboard screenshot

Gemfile.lock

@@ -280,4 +280,4 @@ DEPENDENCIES
   yard-activesupport-concern
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

README.md

@@ -234,6 +234,8 @@ GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
 
 ### Dashboard
 
+![Dashboard UI](https://github.com/bensheldon/good_job/raw/main/SCREENSHOT.png)
+
 _🚧 GoodJob's dashboard is a work in progress. Please contribute ideas and code on [Github](https://github.com/bensheldon/good_job/issues)._
 
 GoodJob includes a Dashboard as a mountable `Rails::Engine`.

gemfiles/rails_5.2.gemfile.lock

@@ -328,4 +328,4 @@ DEPENDENCIES
   yard-activesupport-concern
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

gemfiles/rails_6.0.gemfile.lock

@@ -343,4 +343,4 @@ DEPENDENCIES
   yard-activesupport-concern
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

gemfiles/rails_6.1.gemfile.lock

@@ -345,4 +345,4 @@ DEPENDENCIES
   yard-activesupport-concern
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

gemfiles/rails_head.gemfile.lock

@@ -351,4 +351,4 @@ DEPENDENCIES
   yard-activesupport-concern
 
 BUNDLED WITH
-   2.2.3
+   2.2.4

lib/good_job/configuration.rb

@@ -101,6 +101,9 @@ def poll_interval
       ).to_i
     end
 
+    # Number of seconds to preserve jobs when using the +good_job cleanup_preserved_jobs+ CLI command.
+    # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
+    # @return [Boolean]
     def cleanup_preserved_jobs_before_seconds_ago
       (
         options[:before_seconds_ago] ||

lib/good_job/notifier.rb

@@ -9,6 +9,7 @@ module GoodJob # :nodoc:
   # When a message is received, the notifier passes the message to each of its recipients.
   #
   class Notifier
+    # Raised if the Database adapter does not implement LISTEN.
     AdapterCannotListenError = Class.new(StandardError)
 
     # Default Postgres channel for LISTEN/NOTIFY

lib/good_job/poller.rb

@@ -19,6 +19,9 @@ class Poller
     #   @return [array<GoodJob:Poller>]
     cattr_reader :instances, default: [], instance_reader: false
 
+    # Creates GoodJob::Poller from a GoodJob::Configuration instance.
+    # @param configuration [GoodJob::Configuration]
+    # @return [GoodJob::Poller]
     def self.from_configuration(configuration)
       GoodJob::Poller.new(poll_interval: configuration.poll_interval)
     end

spec/test_app/db/schema.rb

@@ -2,8 +2,8 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# This file is the source Rails uses to define your schema when running `rails
-# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
 # be faster and is potentially less error prone than running all of your
 # migrations from scratch. Old migrations may fail to apply correctly if those
 # migrations use external dependencies or application code.