Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation from readme to Errors class yard doc #200

Merged
merged 1 commit into from
Feb 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion lib/lunchmoney/errors.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,23 @@
# frozen_string_literal: true

module LunchMoney
# This class is used to represent errors returned directly from the LunchMoney API
# This class is used to represent errors returned directly from the LunchMoney API. This class has been set up to act
# like an array, delegating a lot of common array getter methods directly to messages for you.
# @example
# api = LunchMoney::Api.new
# response = api.categories
#
# response.class
# => LunchMoney::Errors
#
# response.first
# => "Some error returned by the API"
#
# response.empty?
# => false
#
# response[0]
# => "Some error returned by the API"
class Errors
sig { returns(T::Array[String]) }
attr_accessor :messages
Expand Down