diff --git a/README.md b/README.md index 790f3a97..45ad52e8 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ const options = { outputHtml: true, }; -unRTF +unRtf .convert(file, options) .then((res) => { console.log(res); diff --git a/src/index.js b/src/index.js index a49b0b61..e618ee63 100644 --- a/src/index.js +++ b/src/index.js @@ -287,7 +287,7 @@ class UnRTF { * @param {string} file - Filepath of the RTF file to read. * @param {UnRTFOptions} [options] - Options to pass to the UnRTF binary. * @param {UnRTFExtraOptions} [extras] - Non-CLI options. - * @returns {Promise} A promise that resolves with a stdout string, or rejects with an `Error` object. + * @returns {Promise} A promise that resolves with a stdout string, or rejects with an `Error` object. * @throws {Error} If the file is missing, not an RTF file, or if UnRTF returns an error. */ async convert(file, options = {}, extras = {}) { diff --git a/test/utils/gen-combos.js b/test/utils/gen-combos.js index b34e4a77..bf52fa53 100644 --- a/test/utils/gen-combos.js +++ b/test/utils/gen-combos.js @@ -4,7 +4,7 @@ const btPowerSetRecursive = require("./bt-power-set"); /** * @author Frazer Smith - * @description Utility function to generate unique combinations when provided with an + * @description Generates unique combinations when provided with an * array of objects. * @param {object[]} originalSet - Array of objects. * @returns {object[]} All subsets of array of objects provided.