chore: fix doc lints
This commit is contained in:
parent
411db01786
commit
b5008664c9
|
@ -10,9 +10,10 @@ use std::fmt::Debug;
|
|||
use super::{events::Events, *};
|
||||
use crate::types::{self, Composite, Shared};
|
||||
|
||||
/// Represents a handle to a Gateway connection. A Gateway connection will create observable
|
||||
/// [`GatewayEvents`](GatewayEvent), which you can subscribe to. Gateway events include all currently
|
||||
/// implemented types with the trait [`WebSocketEvent`]
|
||||
/// Represents a handle to a Gateway connection.
|
||||
///
|
||||
/// A Gateway connection will create observable [`Events`], which you can subscribe to.
|
||||
///
|
||||
/// Using this handle you can also send Gateway Events directly.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct GatewayHandle {
|
||||
|
|
|
@ -128,10 +128,10 @@ pub trait Composite<T: Updateable + Clone + Debug> {
|
|||
pub trait IntoShared {
|
||||
/// Uses [`Shared`] to provide an ergonomic alternative to `Arc::new(RwLock::new(obj))`.
|
||||
///
|
||||
/// [`Shared<Self>`] can then be observed using the [`Gateway`], turning the underlying
|
||||
/// [`Shared<Self>`] can then be observed using the gateway, turning the underlying
|
||||
/// `dyn Composite<Self>` into a self-updating struct, which is a tracked variant of a chorus
|
||||
/// entity struct, updating its' held information when new information concerning itself arrives
|
||||
/// over the [`Gateway`] connection, reducing the need for expensive network-API calls.
|
||||
/// over the gateway connection, reducing the need for expensive network-API calls.
|
||||
fn into_shared(self) -> Shared<Self>;
|
||||
}
|
||||
|
||||
|
|
|
@ -66,10 +66,15 @@ pub struct UserModifySchema {
|
|||
///
|
||||
/// Only [UserFlags::PREMIUM_PROMO_DISMISSED], [UserFlags::HAS_UNREAD_URGENT_MESSAGES]
|
||||
/// and DISABLE_PREMIUM can be set.
|
||||
///
|
||||
///
|
||||
/// # Note
|
||||
///
|
||||
/// This is not yet implemented on Spacebar
|
||||
///
|
||||
/// [UserFlags]: crate::types::UserFlags
|
||||
/// [UserFlags::PREMIUM_PROMO_DISMISSED]: crate::types::UserFlags::PREMIUM_PROMO_DISMISSED
|
||||
/// [UserFlags::HAS_UNREAD_URGENT_MESSAGES]:
|
||||
/// crate::types::UserFlags::HAS_UNREAD_URGENT_MESSAGES
|
||||
pub flags: Option<u64>,
|
||||
/// The user's date of birth, can only be set once
|
||||
///
|
||||
|
|
Loading…
Reference in New Issue