Skip to content
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

Merged
merged 11 commits into from
Aug 14, 2022

Conversation

vilgotf
Copy link
Member

@vilgotf vilgotf commented Jun 9, 2022

Denies missing docs on it and any of it's submodules.

I'm unhappy with some parts, see my review.

Denies missing docs on it and any of it's submodules
@github-actions github-actions bot added c-model Affects the model crate t-docs A change to the documentation labels Jun 9, 2022
#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[non_exhaustive]
#[serde(rename_all = "lowercase")]
pub enum ParseTypes {
Copy link
Member Author

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

Copy link
Contributor

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

Copy link
Member Author

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/allowed_mentions/mod.rs Outdated Show resolved Hide resolved
model/src/channel/message/interaction.rs Outdated Show resolved Hide resolved
model/src/channel/message/kind.rs Outdated Show resolved Hide resolved
Comment on lines 121 to 123
/// ID of the [`Guild`] the message was sent in.
///
/// [`Guild`]: crate::guild::Guild
Copy link
Member Author

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?

Copy link
Contributor

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/reaction.rs Outdated Show resolved Hide resolved
model/src/channel/message/flags.rs Outdated Show resolved Hide resolved
model/src/channel/message/mod.rs Outdated Show resolved Hide resolved
model/src/channel/message/interaction.rs Outdated Show resolved Hide resolved
model/src/channel/message/kind.rs Outdated Show resolved Hide resolved
model/src/channel/message/mod.rs Outdated Show resolved Hide resolved
model/src/channel/message/mod.rs Outdated Show resolved Hide resolved
Comment on lines 121 to 123
/// ID of the [`Guild`] the message was sent in.
///
/// [`Guild`]: crate::guild::Guild
Copy link
Contributor

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 Show resolved Hide resolved
model/src/channel/message/mod.rs Outdated Show resolved Hide resolved
model/src/channel/message/reaction.rs Outdated Show resolved Hide resolved
@7596ff
Copy link
Contributor

7596ff commented Jul 19, 2022

Could you update this for discord/discord-api-docs#5093? Two birds one stone, I figure it's in scope

@7596ff 7596ff merged commit 0d2623e into main Aug 14, 2022
@7596ff 7596ff deleted the vilgotf/docs/model/channel/message/fully-doc branch August 14, 2022 00:34
7596ff pushed a commit that referenced this pull request Jan 6, 2023
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-model Affects the model crate t-docs A change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants