-
-
Notifications
You must be signed in to change notification settings - Fork 130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(model): fully document channel::message
#1792
Conversation
Denies missing docs on it and any of it's submodules
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)] | ||
#[non_exhaustive] | ||
#[serde(rename_all = "lowercase")] | ||
pub enum ParseTypes { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This type should be renamed to MentionType
or AllowedMentionsType
, I prefer the first option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can refactor allowed mentions separately
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keeping this unresolved as a reminder
model/src/channel/message/mod.rs
Outdated
/// ID of the [`Guild`] the message was sent in. | ||
/// | ||
/// [`Guild`]: crate::guild::Guild |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to add these sort of interlinks where applicable, should they be expanded on or removed entirely?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't know, maybe? i'd like to have some other input on this
model/src/channel/message/mod.rs
Outdated
/// ID of the [`Guild`] the message was sent in. | ||
/// | ||
/// [`Guild`]: crate::guild::Guild |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't know, maybe? i'd like to have some other input on this
Co-authored-by: Cassandra McCarthy <cassie@7596ff.com>
Could you update this for discord/discord-api-docs#5093? Two birds one stone, I figure it's in scope |
* flattens the `allowed_mentions` module into `message` * removes `AllowedMentionsBuilder` (can be brought back into twilight-util if requested) * renames `ParseTypes` to `MentionType` * rewrites the `AllowedMentions` documentation Follow-up PR to discussion in #1792
Denies missing docs on it and any of it's submodules.
I'm unhappy with some parts, see my review.