From 40f32d56904d815ce43f2924f0739c3514ce9c00 Mon Sep 17 00:00:00 2001 From: TwiN Date: Sun, 20 Nov 2022 23:41:54 -0500 Subject: [PATCH] docs: Mention that Autof is an experimental feature and it may be removed --- README.md | 1 + auto.go | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ab6b21e..1416dfb 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ Note that the example above is not exhaustive. #### Automatic coloring > ⚠ **WARNING**: This is an experimental feature and may be removed depending on user feedback. +> If you have any feedback, please comment on [poll: Keep or Remove color.Autof?](https://github.com/TwiN/go-color/discussions/13). You may use `color.Autof(string, args...)` as a replacement to `fmt.Sprintf(string, args...)` but with colors for each argument: diff --git a/auto.go b/auto.go index 746fbc7..db0324e 100644 --- a/auto.go +++ b/auto.go @@ -10,7 +10,10 @@ var colorsToRotate = []string{ } // Autof automatically colors the arguments given for a specific format. -// Works exactly like fmt.Sprintf +// Works exactly like fmt.Sprintf. +// +// WARNING: THIS IS AN EXPERIMENTAL FEATURE AND IT MAY BE REMOVED BASED ON USER FEEDBACK. +// IF YOU USE THIS FEATURE, PLEASE PROVIDE FEEDBACK ON https://github.com/TwiN/go-color/discussions/13 // // Example: //