Skip to content

Commit

Permalink
docs: Update summary of SocketVoiceChannel.Users (#1714)
Browse files Browse the repository at this point in the history
The inherited summary incorrectly stated that all users who _see_ the channel are returned when in reality only the ones _connected_ are.
  • Loading branch information
Joelius300 authored Dec 14, 2020
1 parent 9d7cb39 commit e385c40
Showing 1 changed file with 6 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ public ICategoryChannel Category
public Task SyncPermissionsAsync(RequestOptions options = null)
=> ChannelHelper.SyncPermissionsAsync(this, Discord, options);

/// <inheritdoc />
/// <summary>
/// Gets a collection of users that are currently connected to this voice channel.
/// </summary>
/// <returns>
/// A read-only collection of users that are currently connected to this voice channel.
/// </returns>
public override IReadOnlyCollection<SocketGuildUser> Users
=> Guild.Users.Where(x => x.VoiceChannel?.Id == Id).ToImmutableArray();

Expand Down

0 comments on commit e385c40

Please sign in to comment.