Skip to content

Commit

Permalink
Fix up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mullermp committed Nov 16, 2024
1 parent ec08e1f commit d9a23eb
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
4 changes: 1 addition & 3 deletions lib/aws-sessionstore-dynamodb.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ module DynamoDB
require_relative 'aws/session_store/dynamo_db/configuration'
require_relative 'aws/session_store/dynamo_db/errors'
require_relative 'aws/session_store/dynamo_db/garbage_collection'
require_relative 'aws/session_store/dynamo_db/locking/base'
require_relative 'aws/session_store/dynamo_db/locking/null'
require_relative 'aws/session_store/dynamo_db/locking/pessimistic'
require_relative 'aws/session_store/dynamo_db/locking'
require_relative 'aws/session_store/dynamo_db/rack_middleware'
require_relative 'aws/session_store/dynamo_db/table'
6 changes: 3 additions & 3 deletions lib/aws/session_store/dynamo_db/errors/base_handler.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module Aws::SessionStore::DynamoDB::Errors
# Each error handler must implement a handle_error method.
#
# @example Sample ErrorHandler class
# class MyErrorHandler < BaseErrorHandler
# class MyErrorHandler < BaseHandler
# # Handles error passed in
# def handle_error(e, env = {})
# File.open(path_to_file, 'w') {|f| f.write(e.message) }
Expand All @@ -17,15 +17,15 @@ class BaseHandler
# An error and an environment (optionally) will be passed in to
# this method and it will determine how to deal
# with the error.
# Must return false if you have handled the error but are not reraising the
# Must return false if you have handled the error but are not re-raising the
# error up the stack.
# You may reraise the error passed.
#
# @param [Aws::DynamoDB::Errors::Base] error error passed in from
# Aws::SessionStore::DynamoDB::RackMiddleware.
# @param [Rack::Request::Environment,nil] env Rack environment
# @return [false] If exception was handled and will not reraise exception.
# @raise [Aws::DynamoDB::Errors] If error has be reraised.
# @raise [Aws::DynamoDB::Errors] If error has be re-raised.
def handle_error(error, env = {})
raise NotImplementedError
end
Expand Down
10 changes: 10 additions & 0 deletions lib/aws/session_store/dynamo_db/locking.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

module Aws::SessionStore::DynamoDB
# @api private
module Locking; end
end

require_relative 'locking/base'
require_relative 'locking/null'
require_relative 'locking/pessimistic'

0 comments on commit d9a23eb

Please sign in to comment.