Skip to content

Commit 4be8ba1

Browse files
authored
Update README.md
* Fix yarddoc.
1 parent 99ecfc1 commit 4be8ba1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@ class ResourceInterface
5050

5151
# Returns a hash containing, for each included relationship, an array of the
5252
# resources to be included from that one.
53-
# @param [Array<Symbol>] included_relationships The keys of the relationships
53+
# @param included_relationships [Array<Symbol>] The keys of the relationships
5454
# to be included.
5555
# @return [Hash{Symbol => Array<#ResourceInterface>}]
5656
def jsonapi_related(included_relationships); end
5757

5858
# Returns a JSON API-compliant representation of the resource as a hash.
59-
# @param [Hash] options
60-
# @option [Array<Symbol>, Nil] fields The requested fields, or nil.
61-
# @option [Array<Symbol>] include The requested relationships to
59+
# @param options [Hash]
60+
# @option fields [Array<Symbol>, Nil] The requested fields, or nil.
61+
# @option include [Array<Symbol>] The requested relationships to
6262
# include (defaults to []).
6363
# @return [Hash]
6464
def as_jsonapi(options = {}); end

0 commit comments

Comments
 (0)