-
Notifications
You must be signed in to change notification settings - Fork 80
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
Improve documentation for Peripheral.connect
#614
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Would it make sense to document
BluetoothDisabledException
as another possible exception onPeripheral.connect
? Currently onlyConnectionRejectedException
andCancellationException
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.
Scanner.advertisements
can throwBluetoothDisabledException
andScanFailedException
, which I believe would crash my app if theCoroutineContext
with which I collectadvertisements
does not use aSupervisorJob
and if I don't useFlow.catch
. Would it make sense to document these exceptions on that property?Peripheral.connect
can throwConnectionRejectedException
,BluetoothDisabledException
andConnectionLostException
. Should these be documented?I can create a PR with such documentation if desired.
Originally posted by @degill in #366 (comment)
The text was updated successfully, but these errors were encountered: