Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.1k
gh-132099: Fix documentation for the BTPROTO_HCI protocol#132118
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
gh-132099: Fix documentation for the BTPROTO_HCI protocol#132118
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Is this BSD and Linux-only or are other OSes supported as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The current doc says "everything else" accepts an integer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Can we add an.. availability: …
?
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is a copy from the documentation for BTPROTO_SCO. I do not want to diverge it without reasons.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
..availability::Linux, FreeBSD, NetBSD, DragonFlyBSD | |
Do we want to list officially unsupported os'es here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There is noavailability
directive for BTPROTO_L2CAP and BTPROTO_SCO, and I am not sure what we could write there.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
1d97488
intopython:mainUh oh!
There was an error while loading.Please reload this page.
Thanks@serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13. |
Sorry,@serhiy-storchaka, I could not cleanly backport this to
|
pythonGH-132118)(cherry picked from commit1d97488)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
GH-132482 is a backport of this pull request to the3.13 branch. |
Uh oh!
There was an error while loading.Please reload this page.
📚 Documentation preview 📚:https://cpython-previews--132118.org.readthedocs.build/