Skip to content

Commit

Permalink
doc: fix docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
iamtraction committed Sep 3, 2018
1 parent 74eb936 commit c7ed0e4
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions source/cleverbot.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ const request = require('request-promise-native');
class Cleverbot {
/**
* @param {Object} options Options for initializing the cleverbot.js library.
* @param {APIKey} options.APIKey The Cleverbot API Key.
* @param {String} options.APIKey The Cleverbot API Key.
* @param {Boolean} options.preserveState Whether to preserve the state of the
* conversations.
* @example
* const Cleverbot = require('cleverbot.js');
* let options = {
* const options = {
* APIKey: 'CFDoi4234falFOFaSfwepxXhBRW',
* preserveState: true
* };
* cleverbot = new Cleverbot(options);
* const cleverbot = new Cleverbot(options);
*/
constructor(options) {
this.options = options && typeof options === 'object' ? options : {};
Expand All @@ -27,7 +27,7 @@ class Cleverbot {
}

/**
* Generates the path for the API request for the given messaage from user.
* Generates the path for the API request for the given message from user.
* @function _getPath
* @param {String} message The message sent by the user.
* @returns {String} The path of the API request.
Expand All @@ -47,8 +47,8 @@ class Cleverbot {
}

/**
* Generates the path for the API request for the given messaage from user.
* @function _getPath
* Write a message to Cleverbot.
* @function write
* @param {String} message The message sent by the user.
* @returns {String} The Cleverbot response object.
* @example
Expand Down

0 comments on commit c7ed0e4

Please sign in to comment.