Skip to content
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.

Sign up for GitHub

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

gh-132099: Fix documentation for the BTPROTO_HCI protocol #132118

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+10 −4
Open

gh-132099: Fix documentation for the BTPROTO_HCI protocol #132118

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ad9c06
gh-132099: Fix documentation for the BTPROTO_HCI protocol
serhiy-storchaka Apr 5, 2025
1c32480
Apply suggestions from code review
serhiy-storchaka Apr 5, 2025
e17e43e
Update Doc/library/socket.rst
serhiy-storchaka Apr 5, 2025
0e8b750
Update Doc/library/socket.rst
serhiy-storchaka Apr 5, 2025
7bd9d06
Clean up.
serhiy-storchaka Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,19 @@ created. Socket addresses are represented as follows:
- :const:`BTPROTO_RFCOMM` accepts ``(bdaddr, channel)`` where ``bdaddr``
is the Bluetooth address as a string and ``channel`` is an integer.

- :const:`BTPROTO_HCI` accepts ``(device_id,)`` where ``device_id`` is
either an integer or a string with the Bluetooth address of the
interface. (This depends on your OS; NetBSD and DragonFlyBSD expect
a Bluetooth address while everything else expects an integer.)
- :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'``)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Member Author

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.

On Linux it accepts a tuple ``(device_id,)`` where ``device_id``
Copy link
Member

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?

Copy link
Contributor

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.

Copy link
Member Author

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).

Copy link
Contributor

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: … ?

is an integer specifying the number of the Bluetooth device.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. availability:: Linux, FreeBSD, NetBSD, DragonFlyBSD

Do we want to list officially unsupported os'es here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no availability directive for BTPROTO_L2CAP and BTPROTO_SCO, and I am not sure what we could write there.

.. versionchanged:: 3.2
NetBSD and DragonFlyBSD support added.

.. versionchanged:: 3.13.3
FreeBSD support added.

- :const:`BTPROTO_SCO` 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'``) This protocol is not
Expand Down
Loading