From c9f2954021104e30d03b3948660a9ba374d50f78 Mon Sep 17 00:00:00 2001 From: Marcin Franczyk Date: Mon, 2 Dec 2024 12:38:01 +0100 Subject: [PATCH] Fix the usage doc and code desc Signed-off-by: Marcin Franczyk --- api/nfd/v1alpha1/types.go | 2 +- docs/usage/image-compatibility.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api/nfd/v1alpha1/types.go b/api/nfd/v1alpha1/types.go index a28275e94..28dc51817 100644 --- a/api/nfd/v1alpha1/types.go +++ b/api/nfd/v1alpha1/types.go @@ -306,7 +306,7 @@ type MatchExpression struct { IsMatch bool `json:"-"` } -// Override MarshalJSON to hide the IsMatch field, +// MarshalJSON to hide the IsMatch field, // preventing users from accessing it and avoiding potential API confusion. // This field is returned only after rule processing to indicate if the expression matched the host. func (m *MatchExpression) MarshalJSON() ([]byte, error) { diff --git a/docs/usage/image-compatibility.md b/docs/usage/image-compatibility.md index 4b5a38561..b29b425f1 100644 --- a/docs/usage/image-compatibility.md +++ b/docs/usage/image-compatibility.md @@ -54,7 +54,7 @@ the host. - **description** - *string* This OPTIONAL property provides a brief description of a compatibility set. -### Example +#### Example ```yaml version: v1alpha1