Skip to content

Commit

Permalink
Fix up copypasted class description comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mdholloway committed Jan 16, 2025
1 parent ef57b8c commit d5aef86
Show file tree
Hide file tree
Showing 17 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
class AcknowledgementsClaimTransformer < BaseClaimTransformer
# Transformer for acknowledgements (P33) claims.
PREFIX = 'acknowledgements'

def initialize(claim, _)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'time'

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for production date (P23) claims.
class DateClaimTransformer < QualifiedClaimTransformer
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for dated? (P26) claims.
class DatedClaimTransformer < BaseClaimTransformer
PREFIX = 'dated'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for extracting links from relevant Digital Scriptorium claims.
# Transformer for IIIF Manifest (P41) claims.
class IiifManifestClaimTransformer < LinkClaimTransformer
PREFIX = 'iiif_manifest'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for holding institution (P5) claims.
class InstitutionClaimTransformer < QualifiedClaimTransformer
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for extracting links from relevant Digital Scriptorium claims.
# Transformer for institutional record (P9) claims.
class InstitutionalRecordClaimTransformer < LinkClaimTransformer
PREFIX = 'institutional_record'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for language (P21) claims.
class LanguageClaimTransformer < QualifiedClaimTransformer
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for material (P30) claims.
class MaterialClaimTransformer < QualifiedClaimTransformer
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for name (P14) claims.
# Transformer for associated name (P14) claims.
# NOTE: Name claims produce fields prefixes derived from the value of their role (P15) qualifiers
# (owner, author, scribe, artist, agent).
class NameClaimTransformer < QualifiedClaimTransformerWithFacetFallback
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for acknowledgements (P32) claims.
class NoteClaimTransformer < BaseClaimTransformer
PREFIX = 'note'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for physical description (P29) claims.
class PhysicalDescriptionClaimTransformer < BaseClaimTransformer
PREFIX = 'physical_description'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for place (P28) claims.
class PlaceClaimTransformer < QualifiedClaimTransformer
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields
# with a fallback to the value as-recorded for the facet field.
class QualifiedClaimTransformerWithFacetFallback < QualifiedClaimTransformer
def facet_values
super.any? ? super : [claim.data_value]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for shelfmark (P8) claims.
class ShelfmarkClaimTransformer < BaseClaimTransformer
PREFIX = 'shelfmark'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for genre (P18) and subject (P19) claims.
class TermClaimTransformer < QualifiedClaimTransformerWithFacetFallback
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Transformer for converting qualified claims of Digital Scriptorium items into Solr fields.
# Transformer for title (P10) claims.
class TitleClaimTransformer < QualifiedClaimTransformerWithFacetFallback
include PropertyId

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module DigitalScriptorium
# Base transformer class providing a common interface for all transformers.
# Transformer for uniform title (P12) claims.
class UniformTitleClaimTransformer < BaseClaimTransformer
PREFIX = 'uniform_title'

Expand Down

0 comments on commit d5aef86

Please sign in to comment.