bevy icon indicating copy to clipboard operation
bevy copied to clipboard

document file formats for `bytes` field of `AudioSource`

Open dis-da-mor opened this issue 3 years ago • 4 comments

Objective

Fixes #6299

Solution

Change one line of documentation.

dis-da-mor avatar Nov 14 '22 17:11 dis-da-mor

Change LGTM :) Can you update your PR title to explain what was done so it's easier to skim in the commit history?

alice-i-cecile avatar Nov 14 '22 17:11 alice-i-cecile

👋 Could you change your PR title to something that describe the change? The PR title will end up as the commit in git history and it will improve readability of the git log.

Also, do you know if the formats supported depend on the feature flag enabled, or if those are only used when decoding files?

mockersf avatar Nov 14 '22 17:11 mockersf

do you know if the formats supported depend on the feature flag enabled, or if those are only used when decoding files?

As far as I know you could store any bytes you would like in the bytes field, but playback won't work if the bytes aren't one of the supported formats and that format is enabled in the feature flag.

dis-da-mor avatar Nov 14 '22 20:11 dis-da-mor

You should run cargo fmt --all. Also check if that link to rodio::decoder::Decoder is working in cargo doc.

harudagondi avatar Nov 15 '22 06:11 harudagondi

bors r+

alice-i-cecile avatar Dec 11 '22 18:12 alice-i-cecile