kozabrada123/chorus
kozabrada123
/
chorus
mirror of https://github.com/polyphony-chat/chorus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: fix doc lints

This commit is contained in:
kozabrada123 2024-08-28 19:28:08 +02:00
parent 411db01786
commit b5008664c9
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/gateway/handle.rs
View File

@ -10,9 +10,10 @@ use std::fmt::Debug;
use super::{events::Events, *}; use super::{events::Events, *};
use crate::types::{self, Composite, Shared}; use crate::types::{self, Composite, Shared};
/// Represents a handle to a Gateway connection. A Gateway connection will create observable /// Represents a handle to a Gateway connection.
/// [`GatewayEvents`](GatewayEvent), which you can subscribe to. Gateway events include all currently ///
/// implemented types with the trait [`WebSocketEvent`] /// A Gateway connection will create observable [`Events`], which you can subscribe to.
///
/// Using this handle you can also send Gateway Events directly. /// Using this handle you can also send Gateway Events directly.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct GatewayHandle { pub struct GatewayHandle {

4
src/types/entities/mod.rs
View File

@ -128,10 +128,10 @@ pub trait Composite<T: Updateable + Clone + Debug> {
pub trait IntoShared { pub trait IntoShared {
/// Uses [`Shared`] to provide an ergonomic alternative to `Arc::new(RwLock::new(obj))`. /// 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 /// `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 /// 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>; fn into_shared(self) -> Shared<Self>;
} }

9
src/types/schema/user.rs
View File

@ -31,7 +31,7 @@ pub struct UserModifySchema {
// TODO: Add a CDN data type // TODO: Add a CDN data type
pub avatar: Option<String>, pub avatar: Option<String>,
/// Note: This is not yet implemented on Spacebar /// Note: This is not yet implemented on Spacebar
pub avatar_decoration_id: Option<Snowflake>, pub avatar_decoration_id: Option<Snowflake>,
/// Note: This is not yet implemented on Spacebar /// Note: This is not yet implemented on Spacebar
pub avatar_decoration_sku_id: Option<Snowflake>, pub avatar_decoration_sku_id: Option<Snowflake>,
/// The user's email address; if changing from a verified email, email_token must be provided /// The user's email address; if changing from a verified email, email_token must be provided
@ -66,10 +66,15 @@ pub struct UserModifySchema {
/// ///
/// Only [UserFlags::PREMIUM_PROMO_DISMISSED], [UserFlags::HAS_UNREAD_URGENT_MESSAGES] /// Only [UserFlags::PREMIUM_PROMO_DISMISSED], [UserFlags::HAS_UNREAD_URGENT_MESSAGES]
/// and DISABLE_PREMIUM can be set. /// and DISABLE_PREMIUM can be set.
/// ///
/// # Note /// # Note
/// ///
/// This is not yet implemented on Spacebar /// 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>, pub flags: Option<u64>,
/// The user's date of birth, can only be set once /// The user's date of birth, can only be set once
/// ///