Address ruff D (#1754)

pyproject.toml

@@ -291,10 +291,6 @@ ignore = [
   'D101', # Missing docstring in public class
   'D102', # Missing docstring in public method
   'D103', # Missing docstring in public function
-  'D104', # Missing docstring in public package
-  'D105', # Missing docstring in magic method
-  'D400', # [*] First line should end with a period
-  'D403', # [*] First word of the first line should be capitalized: `tokenize` -> `Tokenize`
   'E501', # line-too-long, already covered by black
   'ERA001', # [*] Found commented-out code
   'FBT001', # Boolean positional arg in function definition

src/ansible_navigator/tm_tokenize/__init__.py

@@ -0,0 +1 @@
+"""Initialization file for the tokenization subsystem."""

src/ansible_navigator/tm_tokenize/fchainmap.py

@@ -9,7 +9,11 @@
 
 
 class Indexable(Generic[TKey_contra, TValue_co], Protocol):
-    def __getitem__(self, key: TKey_contra) -> TValue_co: ...
+    def __getitem__(self, key: TKey_contra) -> TValue_co:
+        """Get the value associated with the given key.
+
+        :param key: The key to retrieve the value for.
+        """
 
 
 class FChainMap(Generic[TKey_contra, TValue_co]):
@@ -22,6 +26,12 @@ def __init__(self, *mappings: Indexable[TKey_contra, TValue_co]) -> None:
         self._mappings = mappings
 
     def __getitem__(self, key: TKey_contra) -> TValue_co:
+        """Get the value associated with the given key.
+
+        :param key: The key to retrieve the value for.
+        :return: The value associated with the key.
+        :raises KeyError: If the key is not found in any of the mappings.
+        """
         for mapping in reversed(self._mappings):
             try:
                 return mapping[key]

src/ansible_navigator/tm_tokenize/rules.py

@@ -65,7 +65,7 @@ class Entry(NamedTuple):
 
 
 class _Rule(Protocol):
-    """hack for recursive types python/mypy#731"""
+    """hack for recursive types python/mypy#731."""
 
     @property
     def name(self) -> tuple[str, ...]: ...

src/ansible_navigator/tm_tokenize/tokenize.py

@@ -17,7 +17,7 @@ def tokenize(
     line: str,
     first_line: bool,
 ) -> tuple[State, Regions]:
-    """tokenize a string into it's parts"""
+    """Tokenize a string into it's parts."""
     ret: list[Region] = []
     pos = 0
     boundary = state.cur.boundary

src/ansible_navigator/tm_tokenize/utils.py

@@ -8,6 +8,6 @@
 
 
 def uniquely_constructed(t: T) -> T:
-    """avoid tuple.__hash__ for "singleton" constructed objects"""
+    """Avoid tuple.__hash__ for "singleton" constructed objects."""
     t.__hash__ = object.__hash__  # type: ignore[assignment]
     return t