Skip to content

Commit

Permalink
Remove outdated documentation referring to read-locks (serenity-rs#2831)
Browse files Browse the repository at this point in the history
  • Loading branch information
GnomedDev committed Apr 1, 2024
1 parent 6b49172 commit 9114d56
Showing 1 changed file with 0 additions and 24 deletions.
24 changes: 0 additions & 24 deletions src/model/guild/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1682,12 +1682,6 @@ impl Guild {
/// It would be sorted:
/// - "zeya", "zeyaa", "zeyla", "zeyzey", "zeyzeyzey"
///
/// **Locking**: First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed after being sorted in
/// the originally correct position. However, since the read-locks are dropped after borrowing
/// the name, the names might have been changed by the user, the sorted list cannot account for
/// this.
///
/// **Note**: This will only search members that are cached. If you want to search all members
/// in the guild via the Http API, use [`Self::search_members`].
#[must_use]
Expand Down Expand Up @@ -1751,12 +1745,6 @@ impl Guild {
/// setting `sorted` to `true` will result in an overhead, as both fields have to be considered
/// again for sorting.
///
/// **Locking**: First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed after being sorted in
/// the originally correct position. However, since the read-locks are dropped after borrowing
/// the name, the names might have been changed by the user, the sorted list cannot account for
/// this.
///
/// **Note**: This will only search members that are cached. If you want to search all members
/// in the guild via the Http API, use [`Self::search_members`].
#[must_use]
Expand Down Expand Up @@ -1807,12 +1795,6 @@ impl Guild {
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// **Locking**: First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed after being sorted in
/// the originally correct position. However, since the read-locks are dropped after borrowing
/// the name, the names might have been changed by the user, the sorted list cannot account for
/// this.
///
/// **Note**: This will only search members that are cached. If you want to search all members
/// in the guild via the Http API, use [`Self::search_members`].
#[must_use]
Expand Down Expand Up @@ -1856,12 +1838,6 @@ impl Guild {
/// **Note**: Instead of panicking, when sorting does not find a nick, the username will be
/// used (this should never happen).
///
/// **Locking**: First collects a [`Member`]'s nick directly or by read-locking all inner
/// [`User`]s (in case of no nick, see note above), and then sorts. This ensures that no name
/// is being changed after being sorted in the originally correct position. However, since the
/// read-locks are dropped after borrowing the name, the names might have been changed by the
/// user, the sorted list cannot account for this.
///
/// **Note**: This will only search members that are cached. If you want to search all members
/// in the guild via the Http API, use [`Self::search_members`].
#[must_use]
Expand Down

0 comments on commit 9114d56

Please sign in to comment.