aboutsummaryrefslogtreecommitdiff
path: root/src/gateway
diff options
context:
space:
mode:
authorErk- <[email protected]>2018-08-09 20:34:33 +0200
committerzeyla <[email protected]>2018-08-09 11:34:33 -0700
commit40053a71931bb63c43eb6f469ee3c94383c9e90a (patch)
tree79c2fabc1229d0543205bc6daf8ebebc6ebc9755 /src/gateway
parent[routing] Fix various incorrect routes. (#364) (diff)
downloadserenity-40053a71931bb63c43eb6f469ee3c94383c9e90a.tar.xz
serenity-40053a71931bb63c43eb6f469ee3c94383c9e90a.zip
Fix all the dead links in the docs
Diffstat (limited to 'src/gateway')
-rw-r--r--src/gateway/mod.rs21
-rw-r--r--src/gateway/shard.rs13
2 files changed, 15 insertions, 19 deletions
diff --git a/src/gateway/mod.rs b/src/gateway/mod.rs
index ffacba7..07d882c 100644
--- a/src/gateway/mod.rs
+++ b/src/gateway/mod.rs
@@ -3,9 +3,9 @@
//!
//! A shard is an interface for the lower-level receiver and sender. It provides
//! what can otherwise be thought of as "sugar methods". A shard represents a
-//! single connection to Discord. If acting as a [`Bot`] user, you can make
-//! use of a method named "sharding" to have multiple shards, potentially
-//! offloading some server load to another server(s).
+//! single connection to Discord. You can make use of a method named "sharding"
+//! to have multiple shards, potentially offloading some server load to another
+//! server(s).
//!
//! # Sharding
//!
@@ -38,15 +38,12 @@
//! instance. This should be used when you, for example, want to split 10 shards
//! across 3 instances.
//!
-//! **Note**: User accounts can not shard. Use [`Client::start`].
-//!
-//! [`Bot`]: ../enum.LoginType.html#variant.Bot
-//! [`Client`]: ../struct.Client.html
-//! [`Client::start`]: ../struct.Client.html#method.start
-//! [`Client::start_autosharded`]: ../struct.Client.html#method.start_autosharded
-//! [`Client::start_shard`]: ../struct.Client.html#method.start_shard
-//! [`Client::start_shard_range`]: ../struct.Client.html#method.start_shard_range
-//! [`Client::start_shards`]: ../struct.Client.html#method.start_shards
+//! [`Client`]: ../client/struct.Client.html
+//! [`Client::start`]: ../client/struct.Client.html#method.start
+//! [`Client::start_autosharded`]: ../client/struct.Client.html#method.start_autosharded
+//! [`Client::start_shard`]: ../client/struct.Client.html#method.start_shard
+//! [`Client::start_shard_range`]: ../client/struct.Client.html#method.start_shard_range
+//! [`Client::start_shards`]: ../client/struct.Client.html#method.start_shards
//! [docs]: https://discordapp.com/developers/docs/topics/gateway#sharding
mod error;
diff --git a/src/gateway/shard.rs b/src/gateway/shard.rs
index 13944e6..09a3b69 100644
--- a/src/gateway/shard.rs
+++ b/src/gateway/shard.rs
@@ -56,7 +56,7 @@ use websocket::{
///
/// See the documentation for [`new`] on how to use this.
///
-/// [`Client`]: ../struct.Client.html
+/// [`Client`]: ../client/struct.Client.html
/// [`new`]: #method.new
/// [`receive`]: #method.receive
/// [docs]: https://discordapp.com/developers/docs/topics/gateway#sharding
@@ -640,8 +640,8 @@ impl Shard {
/// Note that, if the shard is already in a stage of
/// [`ConnectionStage::Connecting`], then no action will be performed.
///
- /// [`ConnectionStage::Connecting`]: ../../../gateway/enum.ConnectionStage.html#variant.Connecting
- /// [`session_id`]: ../../../gateway/struct.Shard.html#method.session_id
+ /// [`ConnectionStage::Connecting`]: ../gateway/enum.ConnectionStage.html#variant.Connecting
+ /// [`session_id`]: ../gateway/struct.Shard.html#method.session_id
pub fn should_reconnect(&mut self) -> Option<ReconnectType> {
if self.stage == ConnectionStage::Connecting {
return None;
@@ -733,10 +733,9 @@ impl Shard {
/// # }
/// ```
///
- /// [`Event::GuildMembersChunk`]:
- /// ../../model/event/enum.Event.html#variant.GuildMembersChunk
- /// [`Guild`]: ../../model/guild/struct.Guild.html
- /// [`Member`]: ../../model/guild/struct.Member.html
+ /// [`Event::GuildMembersChunk`]: ../model/event/enum.Event.html#variant.GuildMembersChunk
+ /// [`Guild`]: ../model/guild/struct.Guild.html
+ /// [`Member`]: ../model/guild/struct.Member.html
pub fn chunk_guilds<It>(
&mut self,
guild_ids: It,