Name changes & documentation updates #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes frequenz-floss#58 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Fixes frequenz-floss#59 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Fixes frequenz-floss#60 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
github-actions
bot
added
the
part:protobuf
stefan-brus-frequenz
force-pushed
the
v0110
branch
from
4d8c641
to
0068258
Compare
Fixes frequenz-floss#60 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Fixes frequenz-floss#61 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Fixes frequenz-floss#62 Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Signed-off-by: Stefan Brus <stefan.brus@frequenz.com>
Bumps [pytest](https://github.com/pytest-dev/pytest) from 7.4.0 to 7.4.2. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest@7.4.0...7.4.2) --- updated-dependencies: - dependency-name: pytest dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
stefan-brus-frequenz
force-pushed
the
v0110
branch
from
9004f5c
to
727c554
Compare
github-actions
bot
added
the
part:tooling
|
Before merging anything I strongly recommend trying out how it is rendered doing: pip install -e .[dev-mkdocs]
mkdocs serveRemember Markdown is used, so probably things like You can also download the generate site from the CI job artifacts ( |
|
It seems like the file header is not rendered at all 😢 |
Any suggested fixes before merging this? |
llucax
reviewed
Sep 11, 2023
Comment on lines
3
to
29
| // Frequenz gRPC API to propagate dispatches to microgrids | ||
| // Overview: | ||
| // The API serves to automate the process of electricity dispatches for microgrids. | ||
| // In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power | ||
| // between different components within a microgrid or between a microgrid and the main grid. | ||
| // This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), | ||
| // or demand (drawing electricity from the grid or from other components like batteries and solar arrays). | ||
| // | ||
| // Objective: | ||
| // The primary objective of this API is to streamline and automate the complex task of electricity dispatching, | ||
| // making it easier to manage local electricity supply and demand efficiently. | ||
| // | ||
| // Key Features: | ||
| // - Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components. | ||
| // - Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules. | ||
| // - Fine-grained control: Dispatch individual microgrid components or entire component categories. | ||
| // | ||
| // Example Use Cases: | ||
| // - Charging or discharging a battery based on optimal time-of-use rates. | ||
| // - Limiting the output of a Photovoltaic (PV) array during periods of low demand. | ||
| // - Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to | ||
| // support grid operations. | ||
| // - Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing. | ||
| // | ||
| // Target Audience: | ||
| // This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid | ||
| // electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in | ||
| // electrical engineering and systems. |
There was a problem hiding this comment.
Just to emphasize this, sadly the file-level documentation is not rendered at all. Since this is very important info it would be nice to include it somewhere else. Maybe as part of the service MicrogridDispatchService block documentation?
@thomas-nicolai-frequenz FYI for when you create new issues with specs for new APIs.
There was a problem hiding this comment.
Created a separate issue for this: #67
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #58
Fixes #59
Fixes #60
Fixes #61
Fixes #62