Skip to content

Commit

Permalink
Correct documentation for UserId::to_user (#2809)
Browse files Browse the repository at this point in the history
The documentation was never updated after #2662 removed the user cache.
  • Loading branch information
jamesbt365 authored and GnomedDev committed May 14, 2024
1 parent 1eb9e55 commit 097b823
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions src/model/user.rs
Original file line number Diff line number Diff line change
Expand Up @@ -680,13 +680,8 @@ impl UserId {
self.direct_message(http, builder).await
}

/// First attempts to find a [`User`] by its Id in the cache, upon failure requests it via the
/// REST API.
///
/// **Note**: If the cache is not enabled, REST API will be used only.
///
/// **Note**: If the cache is enabled, you might want to enable the `temp_cache` feature to
/// cache user data retrieved by this function for a short duration.
/// First attempts to find a [`User`] by its Id in the `temp_cache` if enabled,
/// upon failure requests it via the REST API.
///
/// # Errors
///
Expand Down

0 comments on commit 097b823

Please sign in to comment.