Would it make sense to document BluetoothDisabledException as another possible exception on Peripheral.connect? Currently only ConnectionRejectedException and CancellationException are documented.
To make my intrusion worse: I went through the code and got the following questions, which I can turn into their own issues if thats a better place for them. They both are about documentation.
It looks liks Scanner.advertisements can throw BluetoothDisabledException and ScanFailedException, which I believe would crash my app if the CoroutineContext with which I collect advertisements does not use a SupervisorJob and if I don't use Flow.catch. Would it make sense to document these exceptions on that property?
(Nearly same as my initial question) If I am not mistaken then Peripheral.connect can throw ConnectionRejectedException, BluetoothDisabledException and ConnectionLostException. Should these be documented?
I can create a PR with such documentation if desired.
twyatt
commented
2 months ago
Would it make sense to document
BluetoothDisabledExceptionas another possible exception onPeripheral.connect? Currently onlyConnectionRejectedExceptionandCancellationExceptionare documented.To make my intrusion worse: I went through the code and got the following questions, which I can turn into their own issues if thats a better place for them. They both are about documentation.
Scanner.advertisementscan throwBluetoothDisabledExceptionandScanFailedException, which I believe would crash my app if theCoroutineContextwith which I collectadvertisementsdoes not use aSupervisorJoband if I don't useFlow.catch. Would it make sense to document these exceptions on that property?Peripheral.connectcan throwConnectionRejectedException,BluetoothDisabledExceptionandConnectionLostException. Should these be documented?I can create a PR with such documentation if desired.
Originally posted by @degill in https://github.com/JuulLabs/kable/issues/366#issuecomment-1845255539