From b5a7e5cdf0538ac64303146a9af1107ece15ff49 Mon Sep 17 00:00:00 2001 From: Spooder <31389391+Dream-cake@users.noreply.github.com> Date: Sat, 7 Mar 2020 00:00:11 -0500 Subject: [PATCH] =?UTF-8?q?docs(sharding):=20ShardingManager#createShard?= =?UTF-8?q?=20doesn't=20spawn=20the=20s=E2=80=A6=20(#3875)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fixed createShard() to show an example! * docs(ShardingManager): clarify createdShard docs * docs(Shard): clarify manager parameter * docs(ShardingManager): use an info tag for createShard's param Co-Authored-By: Sugden <28943913+NotSugden@users.noreply.github.com> Co-authored-by: SpaceEEC Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> --- src/sharding/Shard.js | 2 +- src/sharding/ShardingManager.js | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/sharding/Shard.js b/src/sharding/Shard.js index 39237e0ea..3ef8b9ba0 100644 --- a/src/sharding/Shard.js +++ b/src/sharding/Shard.js @@ -15,7 +15,7 @@ let Worker = null; */ class Shard extends EventEmitter { /** - * @param {ShardingManager} manager Manager that is spawning this shard + * @param {ShardingManager} manager Manager that is creating this shard * @param {number} id ID of this shard */ constructor(manager, id) { diff --git a/src/sharding/ShardingManager.js b/src/sharding/ShardingManager.js index c931d35b4..0b9fdd9c1 100644 --- a/src/sharding/ShardingManager.js +++ b/src/sharding/ShardingManager.js @@ -143,10 +143,11 @@ class ShardingManager extends EventEmitter { } /** - * Spawns a single shard. - * @param {number} [id=this.shards.size] ID of the shard to spawn - - * **This is usually not necessary to manually specify.** - * @returns {Shard} + * Creates a single shard. + * Using this method is usually not necessary if you use the spawn method. + * @param {number} [id=this.shards.size] ID of the shard to create + * This is usually not necessary to manually specify. + * @returns {Shard} Note that the created shard needs to be explicitly spawned using its spawn method. */ createShard(id = this.shards.size) { const shard = new Shard(this, id);