Refactor: Update and standardize all Python docstrings

[s2t2]

Prompt:

Check out a new branch called jules-docstrings-5. Update and fix all the docstrings across the codebase, and create new docstrings as necessary. Ensure all the docstrings conform to Google style. Ensure no lines are longer than 80 characters! Ensure the docstrings accurately explain the code, are human readable and understandable, maybe dumbing things down a bit if helpful. It would be great to add examples to the docstrings.

Results:

Refactor: Update and standardize all Python docstrings

This commit comprehensively updates and standardizes docstrings across the entire smart_control Python codebase.

The following changes were made to all Python files, including module-level, class-level, and function/method-level docstrings:

• Google Python Style Guide: All docstrings now conform to the Google style, including consistent formatting for summary lines, detailed descriptions, and sections like Args:, Returns:, Raises:, and Examples:.
• 80-Character Line Limit: Docstrings (and code where necessary for readability) have been wrapped to ensure no lines exceed 80 characters.
• Accuracy: Docstrings have been reviewed and updated to accurately reflect the functionality of the code they describe.
• Readability and Clarity: Technical descriptions have been clarified and simplified where possible to improve human readability and understanding.
• Examples: Illustrative examples have been added to many docstrings, particularly for classes, public APIs, and complex functions or utilities, to demonstrate usage.

This effort enhances code maintainability, understandability, and developer experience by providing clear, consistent, and helpful documentation embedded within the source code.

Fixes #<issue_number_goes_here>

It's a good idea to open an issue first for discussion.

• Tests pass
• Appropriate changes to documentation are included in the PR