From 79c3391921e7b056fcf6136632438640bab57e48 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Sat, 9 Feb 2019 01:15:57 +0800 Subject: [PATCH] Add additional clarification for some methods --- src/Discord.Net.WebSocket/BaseSocketClient.cs | 16 ++++++++++------ src/Discord.Net.WebSocket/DiscordSocketConfig.cs | 3 ++- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.cs b/src/Discord.Net.WebSocket/BaseSocketClient.cs index abaf5989e..a7ebf72d8 100644 --- a/src/Discord.Net.WebSocket/BaseSocketClient.cs +++ b/src/Discord.Net.WebSocket/BaseSocketClient.cs @@ -98,12 +98,14 @@ namespace Discord.WebSocket /// This method gets the user present in the WebSocket cache with the given condition. /// /// Sometimes a user may return null due to Discord not sending offline users in large - /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling - /// . + /// guilds (i.e. guild with 100+ members) actively. To download users on startup and to see + /// more information about this subject, see . /// /// /// This method does not attempt to fetch users that the logged-in user does not have access to (i.e. - /// users who don't share mutual guild(s) with the current user). + /// users who don't share mutual guild(s) with the current user). If you wish to get a user that + /// you do not have access to, consider using the REST implementation of + /// . /// /// /// @@ -120,12 +122,14 @@ namespace Discord.WebSocket /// This method gets the user present in the WebSocket cache with the given condition. /// /// Sometimes a user may return null due to Discord not sending offline users in large - /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling - /// . + /// guilds (i.e. guild with 100+ members) actively. To download users on startup and to see + /// more information about this subject, see . /// /// /// This method does not attempt to fetch users that the logged-in user does not have access to (i.e. - /// users who don't share mutual guild(s) with the current user). + /// users who don't share mutual guild(s) with the current user). If you wish to get a user that + /// you do not have access to, consider using the REST implementation of + /// . /// /// /// diff --git a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs index 9674cff52..6ff83b152 100644 --- a/src/Discord.Net.WebSocket/DiscordSocketConfig.cs +++ b/src/Discord.Net.WebSocket/DiscordSocketConfig.cs @@ -94,7 +94,8 @@ namespace Discord.WebSocket /// Please note that it can be difficult to fill the cache completely on large guilds depending on the /// traffic. If you are using the command system, the default user TypeReader may fail to find the user /// due to this issue. This may be resolved at v3 of the library. Until then, you may want to consider - /// overriding the TypeReader and use as a backup. + /// overriding the TypeReader and use + /// or as a backup. /// /// public bool AlwaysDownloadUsers { get; set; } = false;