docs update

Author: forman

docs/api.md

@@ -2,6 +2,10 @@
 
 All described objects can be imported from the `xrlint.all` module.
 
+## Class `XRLint`
+
+::: xrlint.cli.engine.XRLint
+
 ## Function `new_linter()`
 
 ::: xrlint.linter.new_linter

xrlint/cli/engine.py

@@ -129,7 +129,7 @@ def get_config_for_file(self, file_path: str) -> Config | None:
         """
         return self.config_list.compute_config(file_path)
 
-    def print_config_for_file(self, file_path) -> None:
+    def print_config_for_file(self, file_path: str) -> None:
         """Print computed configuration for the given file.
 
         Args:

xrlint/linter.py

@@ -12,7 +12,7 @@ def new_linter(
     config: Config | dict | None = None,
     **config_kwargs: dict[str, Any],
 ) -> "Linter":
-    """Create a new `Linter` with core rules loaded.
+    """Create a new `Linter` with just the core plugin configured.
 
     Args:
         recommended: `True` if the recommended configurations of the builtin

xrlint/testing.py

@@ -46,10 +46,10 @@ class RuleTester:
     """Utility that helps to test rules.
 
     Args:
-        config: optional xrlint configuration
+        config: optional XRLint configuration.
     """
 
-    def __init__(self, **config):
+    def __init__(self, **config: dict[str, Any]):
         self._config = config
 
     def run(