diff --git a/app/controllers/README.md b/app/controllers/README.md index cdecd2c61..9df0e3380 100644 --- a/app/controllers/README.md +++ b/app/controllers/README.md @@ -73,7 +73,7 @@ Each controller action above corresponds to an URL: | BansController#update | PUT https://danbooru.donmai.us/bans/1234 | PUT /bans/:id | | | | BansController#destroy | DELETE https://danbooru.donmai.us/bans/1234 | DELETE /bans/:id | | | -These routes are defined in [config/routes.rb](../config/routes.rb). +These routes are defined in [config/routes.rb](../../config/routes.rb). # Authorization diff --git a/app/jobs/bigquery_export_job.rb b/app/jobs/bigquery_export_job.rb index 007eea8fd..8e458b49c 100644 --- a/app/jobs/bigquery_export_job.rb +++ b/app/jobs/bigquery_export_job.rb @@ -1,3 +1,7 @@ +# A job that exports a database table to Google Cloud Storage and to Google +# BigQuery. Spawned daily by {DanbooruMaintenance}. +# +# @see BigqueryExportService class BigqueryExportJob < ApplicationJob retry_on Exception, attempts: 0 diff --git a/app/jobs/discord_notification_job.rb b/app/jobs/discord_notification_job.rb index 20251c178..4f17a2191 100644 --- a/app/jobs/discord_notification_job.rb +++ b/app/jobs/discord_notification_job.rb @@ -1,3 +1,5 @@ +# A job that sends notifications about new forum posts to Discord. Spawned by +# the {ForumPost} class when a new forum post is created. class DiscordNotificationJob < ApplicationJob retry_on Exception, attempts: 0 diff --git a/app/jobs/iqdb_add_post_job.rb b/app/jobs/iqdb_add_post_job.rb index a99daa6f0..e94b61cd2 100644 --- a/app/jobs/iqdb_add_post_job.rb +++ b/app/jobs/iqdb_add_post_job.rb @@ -1,3 +1,5 @@ +# A job that adds a post to IQDB when a new post is uploaded, or when a post is +# regenerated. Spawned by the {Post} class. class IqdbAddPostJob < ApplicationJob def perform(post) IqdbClient.new.add_post(post) diff --git a/app/jobs/iqdb_remove_post_job.rb b/app/jobs/iqdb_remove_post_job.rb index 3d4cda697..40832c79b 100644 --- a/app/jobs/iqdb_remove_post_job.rb +++ b/app/jobs/iqdb_remove_post_job.rb @@ -1,3 +1,5 @@ +# A job that removes a post from IQDB when it is deleted. Spawned by the {Post} +# class. class IqdbRemovePostJob < ApplicationJob def perform(post_id) IqdbClient.new.remove(post_id) diff --git a/app/jobs/populate_saved_search_job.rb b/app/jobs/populate_saved_search_job.rb index 81b34c8d8..a67681d69 100644 --- a/app/jobs/populate_saved_search_job.rb +++ b/app/jobs/populate_saved_search_job.rb @@ -1,3 +1,5 @@ +# A job that updates a user's saved searches when they do a search for +# `search:all` or `search: