gh-132099: Fix documentation for the BTPROTO_HCI protocol #132118
Conversation
Doc/library/socket.rst
Outdated
| On FreeBSD, NetBSD and DragonFlyBSD it accepts ``bdaddr`` where ``bdaddr`` | ||
| is a :class:`bytes` object containing the Bluetooth address in a | ||
| string format. (ex. ``b'12:23:34:45:56:67'``) | ||
| On Linux it accepts a tuple ``(device_id,)`` where ``device_id`` |
There was a problem hiding this comment.
Is this BSD and Linux-only or are other OSes supported as well?
There was a problem hiding this comment.
The current doc says "everything else" accepts an integer.
There was a problem hiding this comment.
In code, it is "other OSes". But I have not found information about any other OSes that support this. Windows is not supported. Until recently, FreeBSD was in "other OSes", but this was a bug (see #131668).
There was a problem hiding this comment.
Can we add an .. availability: … ?
Doc/library/socket.rst
Outdated
| - :const:`BTPROTO_HCI` accepts format that depends on your OS. | ||
| On FreeBSD, NetBSD and DragonFlyBSD it accepts ``bdaddr`` where ``bdaddr`` | ||
| is a :class:`bytes` object containing the Bluetooth address in a | ||
| string format. (ex. ``b'12:23:34:45:56:67'``) |
There was a problem hiding this comment.
| string format. (ex. ``b'12:23:34:45:56:67'``) | |
| string format. (For example: ``b'12:23:34:45:56:67'``) |
We can expand IMO, the line is short anyway
There was a problem hiding this comment.
This is a copy from the documentation for BTPROTO_SCO. I do not want to diverge it without reasons.
Co-authored-by: Stan Ulbrych <[email protected]>
| is a :class:`bytes` object containing the Bluetooth address in a | ||
| string format. (ex. ``b'12:23:34:45:56:67'``) | ||
| - On Linux it accepts a tuple ``(device_id,)`` where ``device_id`` | ||
| is an integer specifying the number of the Bluetooth device. | ||
|
|
There was a problem hiding this comment.
| .. availability:: Linux, FreeBSD, NetBSD, DragonFlyBSD | |
Do we want to list officially unsupported os'es here?
There was a problem hiding this comment.
There is no availability directive for BTPROTO_L2CAP and BTPROTO_SCO, and I am not sure what we could write there.
Co-authored-by: Stan Ulbrych <[email protected]>
📚 Documentation preview 📚: https://cpython-previews--132118.org.readthedocs.build/