Skip to content

Commit 5770026

Browse files
committed
Documentation fixes.
1 parent 8635f2b commit 5770026

File tree

3 files changed

+3
-7
lines changed

3 files changed

+3
-7
lines changed

lib/json/ld/api.rb

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,19 +234,18 @@ def self.compact(input, context, options = {})
234234
# @option options [Boolean] :expanded Input is already expanded
235235
# @yield jsonld
236236
# @yieldparam [Hash] jsonld
237-
# The framed JSON-LD document
237+
# The flattened JSON-LD document
238238
# @yieldreturn [Object] returned object
239239
# @return [Object, Hash]
240240
# If a block is given, the result of evaluating the block is returned, otherwise, the flattened JSON-LD document
241-
# @raise [InvalidFrame]
242241
# @see http://json-ld.org/spec/latest/json-ld-api/#framing-algorithm
243242
def self.flatten(input, context, options = {})
244243
flattened = []
245244

246245
# Expand input to simplify processing
247246
expanded_input = options[:expanded] ? input : API.expand(input, options)
248247

249-
# Initialize input using frame as context
248+
# Initialize input using
250249
API.new(expanded_input, context, options) do
251250
debug(".flatten") {"expanded input: #{value.to_json(JSON_STATE) rescue 'malformed json'}"}
252251

lib/json/ld/flatten.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ module Flatten
88
# @param [Array, Hash] input
99
# Expanded JSON-LD input
1010
# @param [Hash] graphs A map of graph name to subjects
11-
# @param [Hash{String => Hash}] graphs
12-
# map of nodes
1311
# @param [String] graph
1412
# The name of the currently active graph that the processor should use when processing.
1513
# @param [String] name

lib/json/ld/frame.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,6 @@ def remove_dependents(id, embeds)
357357
##
358358
# Adds framing output to the given parent.
359359
#
360-
# @param state the current framing state.
361360
# @param parent the parent to add to.
362361
# @param property the parent property, null for an array parent.
363362
# @param output the output to add.
@@ -375,7 +374,7 @@ def add_frame_output(parent, property, output)
375374
# a wildcard child frame will be created that uses the same flags that
376375
# the parent frame used.
377376
#
378-
# @param [Hash] flags: the current framing flags.
377+
# @param [Hash] flags the current framing flags.
379378
# @return [Array<Hash>] the implicit frame.
380379
def create_implicit_frame(flags)
381380
[flags.keys.inject({}) {|memo, key| memo["@#{key}"] = [flags[key]]; memo}]

0 commit comments

Comments
 (0)