Merge pull request #167 from tekktrik/doc/hyperspecific-targets

Hyperspecify targets in documentation
adafruit · Jun 1, 2022 · 6d66d2f · 6d66d2f
2 parents 922a5ab + b8bba9e
commit 6d66d2f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/adafruit_ble/advertising/__init__.py b/adafruit_ble/advertising/__init__.py
@@ -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
 

diff --git a/adafruit_ble/advertising/standard.py b/adafruit_ble/advertising/standard.py
@@ -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"