Update README #195
Merged
Update README #195
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR enriches the README with more detailed descriptions, clearer usage instructions, and improved example annotations.
- Expanded the introduction with a clear project summary and target audience
- Added client initialization guidance and a security note
- Enhanced usage examples with organized bullet lists, inline comments, and updated CLI options
Comments suppressed due to low confidence (3)
README.md:95
- [nitpick] Consider adding a brief bullet list of supported features (like metrics, time range, downsampling) to mirror the component query section and improve consistency.
To query sensor data for a specific microgrid, you can use the following method.
README.md:144
- The opening phrase is a dangling modifier; rephrase to something like “Similar to the previous example, you can query multiple microgrids and their sensors in a single request.”
Equivalent to the previous example, multiple microgrids and their sensors can be queried in a single request.
README.md:200
- Add a comma after the introductory clause for clarity: “In addition to the default CSV format, individual samples can also be output using the
--format iteroption.”
In addition to the default CSV format the individual samples can also be output using the `--format iter` option.
README.md
Outdated
| component_id=100, # ID of the specific component to query | ||
| metrics=[ # List of metrics to retrieve | ||
| Metric.AC_ACTIVE_POWER, # AC active power | ||
| Metric.AC_REACTIVE_POWER # AC reactive power |
There was a problem hiding this comment.
The spacing before the inline comment is one space shorter than the previous line; align the ‘#’ markers consistently across list items for readability.
Suggested change
| Metric.AC_REACTIVE_POWER # AC reactive power | |
| Metric.AC_REACTIVE_POWER, # AC reactive power |
Signed-off-by: cwasicki <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.