Fix documentation comment for COMPONENT_CATEGORY_UNSPECIFIED (#245)

llucax · web-flow · commit cc7d721323cd · 2024-09-12T11:28:22.000Z
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -15,3 +15,4 @@ Update of the `PaginationParams` struct.
 ## Bug Fixes
 
 - Fix a dependency issue by pinning the `grpcio` version and related libraries.
+- Fixed a wrong documentation comment for `COMPONENT_CATEGORY_UNSPECIFIED`.
diff --git a/proto/frequenz/api/common/v1/microgrid/components/components.proto b/proto/frequenz/api/common/v1/microgrid/components/components.proto
@@ -24,8 +24,7 @@ import "google/protobuf/timestamp.proto";
 
 // Enumrated component categories.
 enum ComponentCategory {
-  // An unknown component categories, useful for error handling, and marking
-  // unknown components in a list of components with otherwise known categories.
+  // The component category is unspecified. This should not be used.
   COMPONENT_CATEGORY_UNSPECIFIED = 0;
 
   // The point where the local microgrid is connected to the grid.

Original file line number	Diff line number	Diff line change
@@ -15,3 +15,4 @@ Update of the `PaginationParams` struct.
`15`	`15`	`## Bug Fixes`
`16`	`16`
`17`	`17`	- Fix a dependency issue by pinning the `grpcio` version and related libraries.
	`18`	+- Fixed a wrong documentation comment for `COMPONENT_CATEGORY_UNSPECIFIED`.