Skip to content

Added XML documentation for Embed.cs, first of many - #9

Merged
KubaZ2 merged 15 commits into
NetCordDev:alphafrom
Red-K0:alpha
Dec 18, 2023
Merged

Added XML documentation for Embed.cs, first of many#9
KubaZ2 merged 15 commits into
NetCordDev:alphafrom
Red-K0:alpha

Conversation

@Red-K0

@Red-K0 Red-K0 commented Dec 17, 2023

Copy link
Copy Markdown
Contributor

No description provided.

@KubaZ2 KubaZ2 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please add a new line above each XML documentation?

@Red-K0

Red-K0 commented Dec 17, 2023

Copy link
Copy Markdown
Contributor Author

Could you please add a new line above each XML documentation?

Done and done

@KubaZ2 KubaZ2 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am also not sure if we want to document limits for objects that are received

Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Red-K0 and others added 5 commits December 17, 2023 22:06
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
@Red-K0

Red-K0 commented Dec 17, 2023

Copy link
Copy Markdown
Contributor Author

Updated a fair amount of the documentation to account for review comments.

Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Red-K0 and others added 3 commits December 17, 2023 22:50
Co-authored-by: Kuba_Z2 <77853483+KubaZ2@users.noreply.github.com>
@Red-K0

Red-K0 commented Dec 17, 2023

Copy link
Copy Markdown
Contributor Author

Modified mentions of URLs to strings containing URLs, and matched review comments

@KubaZ2

KubaZ2 commented Dec 17, 2023

Copy link
Copy Markdown
Member

This isn't what I meant. I meant that the type of something that is documented as an URL should be a string. The doc should be for example A thumbnail containing an URL that represents the image or something similar I think

@Red-K0

Red-K0 commented Dec 17, 2023

Copy link
Copy Markdown
Contributor Author

A thumbnail containing a URL? Not quite following what you mean

@KubaZ2

KubaZ2 commented Dec 17, 2023

Copy link
Copy Markdown
Member

Yeah, EmbedThumbnail contains a property named Url alongside with other properties. I don't think calling the whole thing an URL is good because it only contains the URL

@Red-K0

Red-K0 commented Dec 18, 2023

Copy link
Copy Markdown
Contributor Author

Should be fixed now

Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
Comment thread NetCord/Embed.cs Outdated
@KubaZ2

KubaZ2 commented Dec 18, 2023

Copy link
Copy Markdown
Member

Looks good to me now, thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants