Add docs to properties

Dan-wanna-M · Aug 5, 2024 · b60d9fb · b60d9fb
1 parent 2e8885c
commit b60d9fb
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/formatron/extractor.py b/src/formatron/extractor.py
@@ -20,6 +20,9 @@ def __init__(self, capture_name: typing.Optional[str] = None):
 
     @property
     def capture_name(self) -> typing.Optional[str]:
+        """
+        Get the name of the capture, or `None` if the extractor does not capture.
+        """
         return self._capture_name
 
     @abc.abstractmethod
@@ -34,6 +37,9 @@ def extract(self, input_str: str) -> typing.Optional[tuple[str, typing.Any]]:
     @property
     @abc.abstractmethod
     def kbnf_representation(self) -> str:
+        """
+        Get the KBNF representation of the extractor in the generated grammar of a Formatter.
+        """
         pass
 
     def __str__(self):