twilight-rs / twilight

Powerful, flexible, and scalable ecosystem of Rust libraries for the Discord API.
https://discord.gg/twilight-rs
ISC License
652 stars 130 forks source link

release: Preliminary 0.16 migration guide #2317

Closed Gelbpunkt closed 6 months ago

Gelbpunkt commented 6 months ago

Please feel free to directly commit and push reviews or personal changes/additions to the branch.

Gelbpunkt commented 6 months ago

I think the headers should be ordered on the size of impact. I would expect the generic cache models to come first and then perhaps the gateway changes followed by the HTTP changes. Beginning with dependencies and feature-name changes seems odd.

I think that at least feature renames are equally as, if not more important. Anyone who had these features previously enabled will experience immediate breakage before even starting to upgrade their codebase, so I decided to put that first since it's the first thing you'll encounter after changing versions in the Cargo.toml

vilgotf commented 6 months ago

Then I'd at least want the dependencies sections moved down

Gelbpunkt commented 6 months ago

Then I'd at least want the dependencies sections moved down

Should be better now.