From 701a57c508a447e96c89170b1f441a7644b8e351 Mon Sep 17 00:00:00 2001 From: Reuven Harrison Date: Thu, 12 Sep 2024 23:33:28 +0300 Subject: [PATCH] update doc --- checker/generator/doc.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/checker/generator/doc.go b/checker/generator/doc.go index 9071d153..8a508ac5 100644 --- a/checker/generator/doc.go +++ b/checker/generator/doc.go @@ -1,4 +1,11 @@ /* -Package generator generates the messages for the checker package. +Package generator generates the breaking-changes and changelog messages for the checker package. +The output, messages.yaml can be used by the checker package instead of the hardcoded messages under localizations_src. +Advatages over manuallly writing the messages: +- The generated ids and messages are consistent according to the logic in the generator. +- The generator can be easily extended to support more messages. +Additional work needed before using the generator: +- Check that all messages are covered by the generator. +- Decide what to do with Russian messages. */ package generator