From 1338e9bd8e2a29ebe2ce9b45bc651adc1bf5601f Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Sun, 19 Nov 2017 02:30:20 -0500 Subject: [PATCH] Update sharding docs some more --- src/sharding/Shard.js | 4 +++- src/sharding/ShardingManager.js | 10 +++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/sharding/Shard.js b/src/sharding/Shard.js index b54701f40..cff80ad38 100644 --- a/src/sharding/Shard.js +++ b/src/sharding/Shard.js @@ -6,7 +6,9 @@ const { Error } = require('../errors'); const delayFor = require('util').promisify(setTimeout); /** - * A self-contained shard spawned by the {@link ShardingManager}. + * A self-contained shard created by the {@link ShardingManager}. Each one has a {@link ChildProcess} that contains + * an instance of the bot and its {@link Client}. When its child process exits for any reason, the shard will spawn a + * new one to replace it as necessary. * @extends EventEmitter */ class Shard extends EventEmitter { diff --git a/src/sharding/ShardingManager.js b/src/sharding/ShardingManager.js index 4b0ad7b87..f682c5887 100644 --- a/src/sharding/ShardingManager.js +++ b/src/sharding/ShardingManager.js @@ -9,11 +9,11 @@ const delayFor = require('util').promisify(setTimeout); /** * This is a utility class that makes multi-process sharding of a bot an easy and painless experience. - * It works by spawning a self-contained {@link ChildProcess} for each individual shard, each containing its own client. - * They all have a line of communication with the master process, and there are several useful methods that utilise - * it in order to simplify tasks that are normally difficult with multi-process sharding. It can spawn a specific number - * of shards or the amount that Discord suggests for the bot, and takes a path to your main bot script to launch for - * each one. + * It works by spawning a self-contained {@link ChildProcess} for each individual shard, each containing its own + * instance of your bot's {@link Client}. They all have a line of communication with the master process, and there are + * several useful methods that utilise it in order to simplify tasks that are normally difficult with sharding. It can + * spawn a specific number of shards or the amount that Discord suggests for the bot, and takes a path to your main bot + * script to launch for each one. * @extends {EventEmitter} */ class ShardingManager extends EventEmitter {