Skip to content

Hyperspecify targets in documentation #167

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
merged 1 commit into from
Jun 1, 2022
Merged

Hyperspecify targets in documentation #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions adafruit_ble/advertising/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,8 @@ class Advertisement:
"""

match_prefixes = ()
"""For Advertisement, `Advertisement.matches` will always return ``True``.
Subclasses may override this value."""
"""For Advertisement, :py:attr:`~adafruit_ble.advertising.Advertisement.match_prefixes`
will always return ``True``. Subclasses may override this value."""
# cached bytes of merged prefixes.
_prefix_bytes = None

Expand Down
4 changes: 3 additions & 1 deletion adafruit_ble/advertising/standard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,9 @@ class ManufacturerData(AdvertisingDataField):
company_id and the data is structured like an advertisement with a configurable key
format. The order of the serialized data is determined by the order that the
`ManufacturerDataField` attributes are set in - this can be useful for
`Advertisement.match_prefixes` in an `Advertisement` sub-class."""
:py:attr:`~adafruit_ble.advertising.Advertisement.match_prefixes` in an `Advertisement`
sub-class.
"""

def __init__(
self, obj, *, advertising_data_type=0xFF, company_id, key_encoding="B"
Expand Down