Skip to content

Commit 6d66d2f

Browse files
authored
Merge pull request #167 from tekktrik/doc/hyperspecific-targets
Hyperspecify targets in documentation
2 parents 922a5ab + b8bba9e commit 6d66d2f

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

adafruit_ble/advertising/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ class Advertisement:
206206
"""
207207

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

adafruit_ble/advertising/standard.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@ class ManufacturerData(AdvertisingDataField):
207207
company_id and the data is structured like an advertisement with a configurable key
208208
format. The order of the serialized data is determined by the order that the
209209
`ManufacturerDataField` attributes are set in - this can be useful for
210-
`Advertisement.match_prefixes` in an `Advertisement` sub-class."""
210+
:py:attr:`~adafruit_ble.advertising.Advertisement.match_prefixes` in an `Advertisement`
211+
sub-class.
212+
"""
211213

212214
def __init__(
213215
self, obj, *, advertising_data_type=0xFF, company_id, key_encoding="B"

0 commit comments

Comments
 (0)