update document and params name

YahooArchive · Jul 27, 2015 · b0309a0 · b0309a0
1 parent d745b97
commit b0309a0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/api/createNavLinkComponent.md b/docs/api/createNavLinkComponent.md
@@ -6,7 +6,7 @@
 
 | Param Name | Param Type | Description |
 |-----------|-----------|-------------|
-| options | Object | the object taken to overwrite the default attribute when we create NavLink |
+| overwriteSpec | Object | the spec object taken to overwrite the default spec when we create NavLink using React.createClass |
 
 
 ## Example Usage

diff --git a/lib/createNavLinkComponent.js b/lib/createNavLinkComponent.js
@@ -20,10 +20,10 @@ function isModifiedEvent (e) {
 
 /**
  * create NavLink component with custom options
- * @param {Object} options to overwrite the default attributes to create NavLink
+ * @param {Object} overwriteSpec spec to overwrite the default spec to create NavLink
  * @returns {React.Component} NavLink component
  */
-module.exports = function createNavLinkComponent (options) {
+module.exports = function createNavLinkComponent (overwriteSpec) {
     var NavLink = React.createClass(objectAssign({}, {
         displayName: 'NavLink',
         contextTypes: {
@@ -169,6 +169,6 @@ module.exports = function createNavLinkComponent (options) {
                 this.props.children
             );
         }
-    }, options));
+    }, overwriteSpec));
     return NavLink;
 };