Merge pull request #5228 from samvera/tx-docs

add @see documentation to `Hyrax::Controller#transactions`
samvera · Oct 28, 2021 · d51cb75 · d51cb75
2 parents 2a41dba + 351f7b0
commit d51cb75
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/app/controllers/concerns/hyrax/controller.rb b/app/controllers/concerns/hyrax/controller.rb
@@ -35,12 +35,14 @@ def default_url_options
   # @api public
   #
   # @return [#[]] a resolver for Hyrax's Transactions; this *should* be a
-  #   thread-safe Dry::Container, but callers to this method should strictly
-  #   use #[] for access
+  #   thread-safe {Dry::Container}, but callers to this method should strictly
+  #   use +#[]+ for access.
   #
   # @example
   #   transactions['change_set.create_work'].call(my_form)
   #
+  # @see Hyrax::Transactions::Container
+  # @see Hyrax::Transactions::Transaction
   # @see https://dry-rb.org/gems/dry-container
   def transactions
     Hyrax::Transactions::Container