Skip to content

Commit

Permalink
docs: Mention that Autof is an experimental feature and it may be rem…
Browse files Browse the repository at this point in the history
…oved
  • Loading branch information
TwiN committed Nov 21, 2022
1 parent f93e037 commit 40f32d5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion auto.go
Original file line number Diff line number Diff line change
Expand Up @@ -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:
//
Expand Down

0 comments on commit 40f32d5

Please sign in to comment.