Skip to content

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.

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

Merged
serhiy-storchaka merged 7 commits into from
Apr 13, 2025
Merged

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

Changes from 1 commit
Commits
Show all changes
7 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
ac626d4
Merge branch 'main' into docs-bluetooth-hci
serhiy-storchaka Apr 13, 2025
113b9b4
More tweaking.
serhiy-storchaka Apr 13, 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
Prev Previous commit
Next Next commit
Update Doc/library/socket.rst
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka authored Apr 5, 2025
commit 0e8b750d855e4524f8dc43eb195048a8e4fd27b8
1 change: 0 additions & 1 deletion Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,10 @@
is the Bluetooth address as a string and ``channel`` is an integer.

- :const:`BTPROTO_HCI` accepts a 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'``)
- On Linux it accepts a tuple ``(device_id,)`` where ``device_id``

Check warning on line 161 in Doc/library/socket.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Block quote ends without a blank line; unexpected unindent. [docutils]
is an integer specifying the number of the Bluetooth device.
Comment thread
serhiy-storchaka marked this conversation as resolved.

Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 5, 2025

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
Copy Markdown
Member Author

@serhiy-storchaka serhiy-storchaka Apr 5, 2025

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
Expand Down
Loading