Address Documentation TODOs

Author: Behemyth

cppython/builder.py

@@ -82,19 +82,18 @@ def generate_core_data(
         pep621_configuration: PEP621Configuration,
         cppython_configuration: CPPythonLocalConfiguration,
     ) -> CoreData:
-        """_summary_
+        """Parses and returns resolved data from all configuration sources
 
         Args:
-            self: _description_
-            configuration: TODO
-            pep621_configuration: TODO
-            cppython_configuration: TODO
+            configuration: Input configuration
+            pep621_configuration: Project table configuration
+            cppython_configuration: Tool configuration
 
         Raises:
             ConfigError: Raised if data cannot be parsed
 
         Returns:
-            _description_
+            The resolved core object
         """
 
         global_configuration = CPPythonGlobalConfiguration()
@@ -113,21 +112,20 @@ def generate_core_data(
         return CoreData(project_data=project_data, pep621_data=pep621_data, cppython_data=cppython_data)
 
     def extract_vcs_version(self, path: Path) -> str:
-        """_summary_
+        """Locates an available VCS plugin that can report version information about the given path
 
         Args:
-            path: _description_
+            path: The directory to query
 
         Raises:
-            TypeError: _description_
-            TypeError: _description_
+            PluginError: If no VCS plugin can be found
 
         Returns:
-            _description_
+            A version token
         """
 
         if not (vcs_types := self.discover_vcs()):
-            raise TypeError("No VCS plugin found")
+            raise PluginError("No VCS plugin found")
 
         plugin = None
         for vcs_type in vcs_types:
@@ -137,7 +135,7 @@ def extract_vcs_version(self, path: Path) -> str:
                 break
 
         if not plugin:
-            raise TypeError("No applicable VCS plugin found for the given path")
+            raise PluginError("No applicable VCS plugin found for the given path")
 
         return plugin.extract_version(path)
 
@@ -216,18 +214,18 @@ def discover_vcs(self) -> list[type[VersionControl]]:
     def create_generator(
         self, plugin_types: list[type[GeneratorT]], core_data: CoreData, generator_configuration: dict[str, Any]
     ) -> GeneratorT:
-        """_summary_
+        """Creates a generator from input configuration
 
         Args:
-            plugin_types: _description_
-            core_data: _description_
-            generator_configuration: TODO
+            plugin_types: The list of generator types to query
+            core_data: The resolved configuration data
+            generator_configuration: The generator table of the CPPython configuration data
 
         Raises:
-            PluginError: TODO
+            PluginError: Raised if no viable generator plugin was found
 
         Returns:
-            _description_
+            The constructed generator
         """
 
         directory = core_data.project_data.pyproject_file.parent
@@ -275,12 +273,12 @@ def create_providers(
         """Creates Providers from input data
 
         Args:
-            plugin_types: TODO
-            core_data: TODO
-            provider_configuration: TODO
+            plugin_types: The discovered provider plugin types
+            core_data: The resolved configuration data
+            provider_configuration: The provider data table
 
         Returns:
-            TODO
+            A list of constructed provider plugins
         """
 
         plugins = []

cppython/console/interface.py

@@ -56,10 +56,10 @@ def query_vcs(self) -> str:
         return "TODO"
 
     def generate_project(self) -> Project:
-        """_summary_
+        """Aids in project generation. Allows deferred configuration from within the "config" object
 
         Returns:
-            _description_
+            The constructed Project
         """
 
         pyproject_data = tomlkit.loads(self.configuration.pyproject_file.read_text(encoding="utf-8"))

cppython/project.py

@@ -107,12 +107,7 @@ async def download_provider_tools(self) -> None:
                 self.logger.info("The %s provider is already downloaded", provider.name())
 
     def sync(self) -> None:
-        """_summary_
-
-        Raises:
-            exception: _description_
-            exception: _description_
-        """
+        """Gathers sync information from providers and passes it to the generator"""
 
         inputs = []
         for provider in self._providers:

tests/unit/test_project.py

@@ -91,8 +91,8 @@ def test_provider_creation(
         """Test that providers can be created with the mock data available
 
         Args:
-            core_data: TODO
-            project_with_mocks: Local config
+            core_data: The resolved configuration data
+            project_with_mocks: Data with mocks attached
         """
 
         builder = Builder(getLogger())
@@ -115,7 +115,7 @@ def test_generator_creation(
         """Test that providers can be created with the mock data available
 
         Args:
-            core_data: TODO
+            core_data: The resolved configuration data
             project_with_mocks: Local config
         """