Skip to content

Fix typo in trading CLI help text#166

Merged
daniel-zullo-frequenz merged 2 commits into
frequenz-floss:v0.x.xfrom
daniel-zullo-frequenz:fix/cli-help-doc
Jul 31, 2025
Merged

Fix typo in trading CLI help text#166
daniel-zullo-frequenz merged 2 commits into
frequenz-floss:v0.x.xfrom
daniel-zullo-frequenz:fix/cli-help-doc

Conversation

@daniel-zullo-frequenz

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings July 30, 2025 20:18
@daniel-zullo-frequenz
daniel-zullo-frequenz requested a review from a team as a code owner July 30, 2025 20:18
@github-actions github-actions Bot added the part:docs Affects the documentation label Jul 30, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes a typo in the CLI help text where "trades" was incorrectly used instead of "orders" in the docstring for the receive_public_orders function. The change corrects the documentation to accurately reflect that the function handles public orders, not trades.

  • Fixed typo in CLI help text docstring
  • Added release note documenting the fix

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/frequenz/client/electricity_trading/cli/main.py Corrected docstring from "trades" to "orders"
RELEASE_NOTES.md Added bug fix entry and release note template sections

Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
Signed-off-by: Daniel Zullo <daniel.zullo@frequenz.com>
@daniel-zullo-frequenz
daniel-zullo-frequenz added this pull request to the merge queue Jul 31, 2025
Merged via the queue into frequenz-floss:v0.x.x with commit b126399 Jul 31, 2025
5 checks passed
@daniel-zullo-frequenz
daniel-zullo-frequenz deleted the fix/cli-help-doc branch July 31, 2025 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants