Skip to content

Commit

Permalink
Fix clippy::doc_lazy_continuation (#2876)
Browse files Browse the repository at this point in the history
  • Loading branch information
GnomedDev authored May 25, 2024
1 parent a884e3a commit 303bbb6
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 11 deletions.
10 changes: 5 additions & 5 deletions src/gateway/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
//!
//! There are a few methods of sharding available:
//! - [`Client::start_autosharded`]: retrieves the number of shards Discord recommends using from
//! the API, and then automatically starts that number of shards.
//! the API, and then automatically starts that number of shards.
//! - [`Client::start_shard`]: starts a single shard for use in the instance, handled by the
//! instance of the Client. Use this if you only want 1 shard handled by this instance.
//! - [`Client::start_shards`]: starts all shards in this instance. This is best for when you want
//! a completely shared State.
//! instance of the Client. Use this if you only want 1 shard handled by this instance.
//! - [`Client::start_shards`]: starts all shards in this instance. This is best for when you want a
//! completely shared State.
//! - [`Client::start_shard_range`]: start a range of shards within this instance. This should be
//! used when you, for example, want to split 10 shards across 3 instances.
//! used when you, for example, want to split 10 shards across 3 instances.
//!
//! [`Client`]: crate::Client
//! [`Client::start`]: crate::Client::start
Expand Down
4 changes: 2 additions & 2 deletions src/http/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3973,8 +3973,8 @@ impl Http {
///
/// # Arguments
/// * `code` - The invite code.
/// * `member_counts` - Whether to include information about the current number
/// of members in the server that the invite belongs to.
/// * `member_counts` - Whether to include information about the current number of members in
/// the server that the invite belongs to.
/// * `expiration` - Whether to include information about when the invite expires.
/// * `event_id` - An optional server event ID to include with the invite.
///
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ compile_error!(
/// Not exported:
/// - [`crate::json`]: it's a general-purpose JSON wrapper, not intrinsic to serenity
/// - [`crate::framework::standard`]: has many standard_framework-specific items that may collide
/// with items from the rest of serenity
/// with items from the rest of serenity
pub mod all {
#[cfg(feature = "builder")]
#[doc(no_inline)]
Expand Down
2 changes: 1 addition & 1 deletion src/model/channel/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ impl fmt::Display for Channel {
/// This will return a different format for each type of channel:
/// - [`PrivateChannel`]s: the recipient's name;
/// - [`GuildChannel`]s: a string mentioning the channel that users who can see the channel can
/// click on.
/// click on.
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Guild(ch) => fmt::Display::fmt(&ch.id.mention(), f),
Expand Down
7 changes: 7 additions & 0 deletions src/model/guild/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1713,6 +1713,7 @@ impl Guild {
///
/// For the `prefix` "zey" and the unsorted result:
/// - "zeya", "zeyaa", "zeyla", "zeyzey", "zeyzeyzey"
///
/// It would be sorted:
/// - "zeya", "zeyaa", "zeyla", "zeyzey", "zeyzeyzey"
///
Expand Down Expand Up @@ -1763,6 +1764,7 @@ impl Guild {
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
///
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
Expand All @@ -1772,6 +1774,7 @@ impl Guild {
///
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
Expand Down Expand Up @@ -1818,6 +1821,7 @@ impl Guild {
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
///
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
Expand All @@ -1826,6 +1830,7 @@ impl Guild {
///
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
Expand Down Expand Up @@ -1858,6 +1863,7 @@ impl Guild {
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
///
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
Expand All @@ -1866,6 +1872,7 @@ impl Guild {
///
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
Expand Down
2 changes: 1 addition & 1 deletion src/model/invite.rs
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ impl Invite {
/// # Arguments
/// * `code` - The invite code.
/// * `member_counts` - Whether to include information about the current number of members in
/// the server that the invite belongs to.
/// the server that the invite belongs to.
/// * `expiration` - Whether to include information about when the invite expires.
/// * `event_id` - An optional server event ID to include with the invite.
///
Expand Down
2 changes: 1 addition & 1 deletion src/model/permissions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//! Permissions follow a hierarchy:
//! - An account can grant roles to users that are of a lower position than its highest role;
//! - An account can edit roles lesser than its highest role, but can only grant permissions they
//! have;
//! have;
//! - An account can move only roles lesser than its highest role;
//! - An account can only kick/ban accounts with a lesser role than its top role.
//!
Expand Down

0 comments on commit 303bbb6

Please sign in to comment.