From 0c80c779058e6fcec8ae3a2a09a92cbecf1fc2c5 Mon Sep 17 00:00:00 2001 From: Cecile Robert-Michon Date: Mon, 24 Sep 2018 15:23:05 -0700 Subject: [PATCH] fix api rules docs --- api/api-rules/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/api-rules/README.md b/api/api-rules/README.md index caae104243..9c77208d29 100644 --- a/api/api-rules/README.md +++ b/api/api-rules/README.md @@ -12,8 +12,8 @@ e.g. * ***API rule violation: names_match,k8s.io/api/core/v1,Event,ReportingController*** -Make rule returns error when new generated violation report differs from this -checked-in violation report. If new API rule violation is detected, please fix +Make rule returns an error when the newly generated violation report differs from this +checked-in violation report. If a new API rule violation is detected, please fix the API Go source file to pass the API rule check. **The entries in the checked-in violation report should only be removed when existing API rule violation is being fixed, but not added.**