Skip to content

Commit

Permalink
Remove extraneous method documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wam committed Jun 6, 2014
1 parent 1688b7f commit 3ede52f
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions lib/fauna/transaction.rb
Expand Up @@ -57,24 +57,10 @@ def self.execute(actions = [], execution_params = {})
# Escape dollar signs that would ordinarily be interpreted as transaction
# variables.
#
# Per the API documention:
#
# "A variable name begins with a $. Any characters a-z, A-Z, 0-9, -, and _
# immediately following the $ comprise the name. If the $ is followed by
# a {, then the name ends at the next }. The $ literal can be escaped as $$.
#
# Available variables are the members of the params object, and the action
# indexes, beginning from $0, which return the resource member of each
# action result.
#
# If a variable refers to a JSON object, it can be traversed with dot
# notation, for example, ${0.ref}, or ${0.data.name}."
#
# The default mode leaves ${variables} intact, but escapes $variables.
# This allows values containing normal dollar signs to be used.
#
# Setting the mode to :strict will escape _all_ dollar signs, should the
# need arise.
# mode = :strict escapes _all_ dollar signs, should the need arise.

def self.escape(data, mode = :default)
if data.is_a? Hash
Expand Down

0 comments on commit 3ede52f

Please sign in to comment.