Updated the documentation

cedx · Jun 1, 2019 · c93de0f · c93de0f
1 parent 7323607
commit c93de0f
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/doc/features/comment_check.md b/doc/features/comment_check.md
@@ -28,7 +28,7 @@ The exception `message` usually includes some debug information, provided by the
 ```js
 import {Author, Blog, Client, Comment} from '@cedx/akismet';
 
-async function main(): Promise<void> {
+async function main(): Promise {
   try {
     const comment = new Comment(
       new Author('127.0.0.1', 'Mozilla/5.0'),

diff --git a/doc/features/key_verification.md b/doc/features/key_verification.md
@@ -21,7 +21,7 @@ The exception `message` usually includes some debug information, provided by the
 ```js
 import {Blog, Client} from '@cedx/akismet';
 
-async function main(): Promise<void> {
+async function main(): Promise {
   try {
     const client = new Client('123YourAPIKey', new Blog(new URL('https://www.yourblog.com')));
     const isValid = await client.verifyKey();

diff --git a/doc/features/submit_ham.md b/doc/features/submit_ham.md
@@ -6,7 +6,7 @@ Remember that, as explained in the [submit spam](submit_spam.md) documentation,
 that any values you're passing here match up with the original and corresponding [comment check](comment_check.md) call.
 
 ```
-Client#submitHam(comment: Comment): Promise<void>
+Client#submitHam(comment: Comment): Promise
 ```
 
 ## Parameters
@@ -28,7 +28,7 @@ The exception `message` usually includes some debug information, provided by the
 ```js
 import {Author, Blog, Client, Comment} from '@cedx/akismet';
 
-async function main(): Promise<void> {
+async function main(): Promise {
   try {
     const comment = new Comment(
       new Author('127.0.0.1', 'Mozilla/5.0'),

diff --git a/doc/features/submit_spam.md b/doc/features/submit_spam.md
@@ -8,7 +8,7 @@ to be available for [submit spam](submit_spam.md) and [submit ham](submit_ham.md
 you should ensure that the values that you do send match those of the original content.
 
 ```
-Client#submitSpam(comment: Comment): Promise<void>
+Client#submitSpam(comment: Comment): Promise
 ```
 
 ## Parameters
@@ -30,7 +30,7 @@ The exception `message` usually includes some debug information, provided by the
 ```js
 import {Author, Blog, Client, Comment} from '@cedx/akismet';
 
-async function main(): Promise<void> {
+async function main(): Promise {
   try {
     const comment = new Comment(
       new Author('127.0.0.1', 'Mozilla/5.0'),

diff --git a/example/main.js b/example/main.js
@@ -2,7 +2,7 @@ import {Author, Blog, Client, ClientError, Comment, CommentType} from '@cedx/aki
 
 /**
  * Queries the Akismet service.
- * @return {Promise<void>} Completes when the program is terminated.
+ * @return {Promise} Completes when the program is terminated.
  */
 async function main() { // eslint-disable-line no-unused-vars
   try {

diff --git a/gulpfile.esm.js b/gulpfile.esm.js
@@ -94,7 +94,7 @@ task('default', series('version', 'build'));
  * @param {string} command The command to run.
  * @param {string[]} [args] The command arguments.
  * @param {SpawnOptions} [options] The settings to customize how the process is spawned.
- * @return {Promise<void>} Completes when the command is finally terminated.
+ * @return {Promise} Completes when the command is finally terminated.
  */
 function _exec(command, args = [], options = {}) {
   return new Promise((fulfill, reject) => spawn(normalize(command), args, {shell: true, stdio: 'inherit', ...options})