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(http): basic request module documentation #2100

Merged
merged 5 commits into from
Jan 29, 2023

Conversation

zeylahellyer
Copy link
Member

@zeylahellyer zeylahellyer commented Jan 28, 2023

Add basic documentation for the twilight_http::request module, highlighting the typed builders, multipart form support, low-level request construction, and audit log reason support. Included is a short example of how to use audit logs.

This is a response to a support ticket with regard to how adding reasons to requests isn't very discoverable.

Screenshot 2023-01-28 at 10 17 55

Add basic documentation for the `twilight_http::request` module,
highlighting the typed builders, multipart form support, low-level
request construction, and audit log reason support. Included is a short
example of how to use audit logs.

This is a response to a support ticket with regard to how adding reasons
to requests isn't very discoverable.
@github-actions github-actions bot added c-http Affects the http crate t-docs A change to the documentation labels Jan 28, 2023
Copy link
Member

@vilgotf vilgotf left a comment

Choose a reason for hiding this comment

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

We usually start the header level from the highest one, but this looks good enough

@zeylahellyer zeylahellyer merged commit 704a789 into main Jan 29, 2023
@zeylahellyer zeylahellyer deleted the zeyla/docs-http-request-module branch January 29, 2023 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-http Affects the http crate t-docs A change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants