From 59ba793d6408e41ae9c3d18d2d32fc9a58541d5e Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Tue, 22 Sep 2015 14:10:05 -0700 Subject: [PATCH] Use lowercase 'optional' keyword used by docs The docs generator expects 'optional' starting with a lowercase 'o' to mark arguments as optional. Lowercase 'O' to properly generate the docs. --- src/context-menu-manager.coffee | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/context-menu-manager.coffee b/src/context-menu-manager.coffee index 0258fedc7..808ebeb79 100644 --- a/src/context-menu-manager.coffee +++ b/src/context-menu-manager.coffee @@ -83,25 +83,25 @@ class ContextMenuManager # # * `itemsBySelector` An {Object} whose keys are CSS selectors and whose # values are {Array}s of item {Object}s containing the following keys: - # * `label` (Optional) A {String} containing the menu item's label. - # * `command` (Optional) A {String} containing the command to invoke on the + # * `label` (optional) A {String} containing the menu item's label. + # * `command` (optional) A {String} containing the command to invoke on the # target of the right click that invoked the context menu. - # * `enabled` (Optional) A {Boolean} indicating whether the menu item + # * `enabled` (optional) A {Boolean} indicating whether the menu item # should be clickable. Disabled menu items typically appear grayed out. # Defaults to `true`. - # * `submenu` (Optional) An {Array} of additional items. - # * `type` (Optional) If you want to create a separator, provide an item + # * `submenu` (optional) An {Array} of additional items. + # * `type` (optional) If you want to create a separator, provide an item # with `type: 'separator'` and no other keys. - # * `visible` (Optional) A {Boolean} indicating whether the menu item + # * `visible` (optional) A {Boolean} indicating whether the menu item # should appear in the menu. Defaults to `true`. - # * `created` (Optional) A {Function} that is called on the item each time a + # * `created` (optional) A {Function} that is called on the item each time a # context menu is created via a right click. You can assign properties to # `this` to dynamically compute the command, label, etc. This method is # actually called on a clone of the original item template to prevent state # from leaking across context menu deployments. Called with the following # argument: # * `event` The click event that deployed the context menu. - # * `shouldDisplay` (Optional) A {Function} that is called to determine + # * `shouldDisplay` (optional) A {Function} that is called to determine # whether to display this item on a given context menu deployment. Called # with the following argument: # * `event` The click event that deployed the context menu.