diff --git a/Gemfile b/Gemfile index eed18963..c777fc75 100644 --- a/Gemfile +++ b/Gemfile @@ -107,7 +107,7 @@ gem 'chronic' gem 'pg_search' # Settings -# @TODO: migrate to different settings gem +# @todo migrate to different settings gem gem 'rails-settings-cached', '~> 0' gem 'rails-settings-ui' diff --git a/app/assets/javascripts/administrate/custom_chrono.js b/app/assets/javascripts/administrate/custom_chrono.js index 0fa13215..e9c3c998 100644 --- a/app/assets/javascripts/administrate/custom_chrono.js +++ b/app/assets/javascripts/administrate/custom_chrono.js @@ -13,7 +13,7 @@ window.CustomizedChrono = (function() { text: match[0], index: match.index, start: { - day: 1, // TODO: Not great + day: 1, // @todo Not great month: 1, year: parseInt(match[0], 10) } diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index ce89cfb8..24fc2b51 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -4,7 +4,7 @@ class ApplicationController < ActionController::Base include Pagy::Backend include Pundit - # @TODO: disable this if necessary + # @todo disable this if necessary after_action :verify_authorized, unless: :devise_controller? helper MarkdownHelper diff --git a/app/jobs/create_snapshot_job.rb b/app/jobs/create_snapshot_job.rb index 2a453c37..4f712451 100644 --- a/app/jobs/create_snapshot_job.rb +++ b/app/jobs/create_snapshot_job.rb @@ -85,7 +85,7 @@ def add_citations(zio) # Decomposes a rich_text field by saving the text as well # as the associated attachments. # - # @TODO: Possible bug! + # @todo Possible bug! # # If two attachments are different files, but have the same filename, # this could result in overwriting one of them. diff --git a/app/jobs/restore_snapshot_job.rb b/app/jobs/restore_snapshot_job.rb index 5cc2d4a8..6a579acb 100644 --- a/app/jobs/restore_snapshot_job.rb +++ b/app/jobs/restore_snapshot_job.rb @@ -75,12 +75,12 @@ def handle_photo(filename, io) photo_filename = fn_cap.captures[1] photo = Photo.find(photo_id) orig_updated_at = photo.updated_at - # @TODO: patch this so the photo doesn't have to be read into memory + # @todo patch this so the photo doesn't have to be read into memory photo.image.attach(io: StringIO.new(io.read), filename: photo_filename) photo.update_columns(updated_at: orig_updated_at) end - # @TODO: This needs to handle attachments too + # @todo This needs to handle attachments too # This is broken for now def handle_note(filename, io, notes_buffer) content_match = filename.match(%r{\ANotes\/note_([0-9]+)\.html\z}) @@ -99,7 +99,7 @@ def handle_note(filename, io, notes_buffer) fname = filename.gsub!(%r{^Notes\/note_[0-9]+/}, '') - # @TODO: Possible bug! + # @todo Possible bug! # See the create_snapshot_job for the duplicate file/filename problem inner_html.css("action-text-attachment[filename='#{fname}']") .each do |attachment| diff --git a/app/models/concerns/parseable_date.rb b/app/models/concerns/parseable_date.rb index 83507d52..817e492a 100644 --- a/app/models/concerns/parseable_date.rb +++ b/app/models/concerns/parseable_date.rb @@ -22,7 +22,7 @@ def parse(date) parsed_date end - # @TODO: In the event I need to parse years < 1000 or > 9999... fix this + # @todo In the event I need to parse years < 1000 or > 9999... fix this def self.parse_four_digit_year(date) Date.new(date.to_i) if !date.nil? && date.match(/^[1-9][0-9]{3}$/) end diff --git a/app/models/person.rb b/app/models/person.rb index a3831ad1..94c43356 100644 --- a/app/models/person.rb +++ b/app/models/person.rb @@ -100,7 +100,7 @@ def probably_dead? private - # @TODO: More sophisticated probably_alive logic + # @todo More sophisticated probably_alive logic # Obviously a person can live to be older than 90, # but the US census releases records after 70 years # so I figure I'm good here diff --git a/app/views/citations/_citation.html.erb b/app/views/citations/_citation.html.erb index e56ef87b..58543d54 100644 --- a/app/views/citations/_citation.html.erb +++ b/app/views/citations/_citation.html.erb @@ -1,4 +1,4 @@ <% -# @TODO: Make a better partial for Citations +# @todo Make a better partial for Citations %> <%= citation.text %> \ No newline at end of file diff --git a/spec/jobs/restore_snapshot_job_spec.rb b/spec/jobs/restore_snapshot_job_spec.rb index f4fb53b0..45404dff 100644 --- a/spec/jobs/restore_snapshot_job_spec.rb +++ b/spec/jobs/restore_snapshot_job_spec.rb @@ -33,7 +33,7 @@ reference_snapshot[:hashes].keys.each do |file| ref_hash = reference_snapshot[:hashes][file] new_hash = new_snapshot[:hashes][file] - # @TODO: there needs to be better equality checking for snapshots. + # @todo there needs to be better equality checking for snapshots. # When restored, apparently sometimes things get out of order even # though the data *inside* each record is fine. if file.ends_with?('.json') && new_hash != ref_hash