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

Fix CreateAttachment documentation to describe as struct #2906

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Fix CreateAttachment documentation to describe as struct #2906

merged 2 commits into from
Jun 21, 2024

Conversation

limonfort
Copy link
Contributor

This pull request addresses issue #2889 by correcting the documentation for the CreateAttachment struct. The previous documentation incorrectly described CreateAttachment as an enum and stated that it allows a user to pass a Path or a File type to send_files, which was misleading.

Changes made in this pull request:

  • Corrected the documentation for CreateAttachment to accurately reflect that it is a struct.
  • Updated the description to explain that CreateAttachment allows a user to create an attachment from raw data, a file path, a file handle, or a URL.

This fix ensures that developers have accurate and useful information when using the CreateAttachment struct in their applications.

Fixes #2889

@github-actions github-actions bot added the builder Related to the `builder` module. label Jun 21, 2024
@jamesbt365
Copy link
Member

please run cargo +nightly fmt --all.

@limonfort
Copy link
Contributor Author

fixed now i think

@GnomedDev GnomedDev changed the title Fix CreateAttachment documentation to correctly describe it as a struct Fix CreateAttachment documentation to describe as struct Jun 21, 2024
@GnomedDev GnomedDev merged commit dde4491 into serenity-rs:current Jun 21, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builder Related to the `builder` module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CreateAttachment's item-level documentation is outdated
3 participants