Documentation for central classes.

[carl-wanninger]

Hello there,
I wanted to discuss documentation in the repository. I started working with BaseUnit and found the following docstring.

"""
    A base class for a unit. This class is used as a foundation for all units.

    Args:
        id (str): The ID of the unit.
        unit_operator (str): The operator of the unit.
        technology (str): The technology of the unit.
        bidding_strategies (dict[str, BaseStrategy]): The bidding strategies of the unit.
        index (FastIndex): The index of the unit.
        node (str, optional): The node of the unit. Defaults to "".
        forecaster (Forecaster, optional): The forecast of the unit. Defaults to None.
        location (tuple[float, float], optional): The location of the unit. Defaults to (0.0, 0.0).
        **kwargs: Additional keyword arguments.

 """

To me a docstring in class c of the sort: x: the x of the class c has no explanatory value (except maybe that it is friday afternoon and I actually thought this is class d). I even presonally prefer id (str): ... over id (str): The ID of the unit because than I see with one gaze that further documentation is missing.

In my dream world, documentation would answer some of the questions I have when working with a class. Sample questions I actually had, were:

• unit_operator : What is the role of the unit operator? Why can there exist no unit without it?
• technology : What is meant by technology? Why is technology a mandatory argument? Where in the pipeline does technology make a difference?
• bidding_strategies: Why does one unit have multiple bidding strategies? What do the dict key refer to?
• index : What is the FastIndex class? Why was it chosen?
• forecaster: What can the forecaster be used for?

I know good documentation does not grow on trees but classes that are of such importance like BaseUnit, in my opinion, deserve some documentary love.

So the questions I wanted to discuss, are:
- Does someone see any value in documentation of the id (str): The ID of the unit. style?
- Are there classes where you think the documentation should be extended?