From d0513cb95d5a88bf0f51a91b57b5da45e66f0a5f Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Tue, 17 Jun 2014 08:49:57 -0700 Subject: [PATCH] :memo: Doc optional param and default property value --- src/cursor.coffee | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/cursor.coffee b/src/cursor.coffee index df9e5e06b..08e8f7e94 100644 --- a/src/cursor.coffee +++ b/src/cursor.coffee @@ -114,9 +114,10 @@ class Cursor extends Model # Public: Get the RegExp used by the cursor to determine what a "word" is. # - # options: An {Object} with the following keys: + # options: An optional {Object} with the following keys: # :includeNonWordCharacters - A {Boolean} indicating whether to include # non-word characters in the regex. + # (default: true) # # Returns a {RegExp}. wordRegExp: ({includeNonWordCharacters}={})->