Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for the Controllers folder + minor detail for previous docstrings #31

Merged

Conversation

jgrguric96
Copy link
Collaborator

This PR primarily contains the addition of docstrings for the files within the Controllers folder.
It also contains some small additions for the Agents folder files (such as type hints)

Luckily, a lot of context needed for the documentation was already done by mosaik itself with the requirements they have when inheriting the mosaik_api.Simulator class.

The missing docstring details can be expanded upon at a later date.

@jgrguric96 jgrguric96 added the documentation Improvements or additions to documentation label Sep 3, 2024
@jgrguric96 jgrguric96 requested a review from manuGil September 3, 2024 12:51
Agents/prosumer_mosaik.py Outdated Show resolved Hide resolved
Copy link
Member

@manuGil manuGil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing the doc strings. Please read my comment on specific files.
After that you can merge the changes. As a follow up, we should ask researchers to review and complete the missing information.

Agents/prosumer_mosaik.py Outdated Show resolved Hide resolved
Controllers/GPController/gpcontroller_mosaik.py Outdated Show resolved Hide resolved
Controllers/ResidentialController/controller_mosaik.py Outdated Show resolved Hide resolved
Games/p2ptrading_mosaik.py Show resolved Hide resolved
@jgrguric96 jgrguric96 merged commit ad84bd5 into Illuminator-team:dev Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants