Skip to content

Conversation

SungJin1212
Copy link
Member

Edit metadata cache backend description to be more accurate.

Which issue(s) this PR fixes:
Fixes

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@dosubot dosubot bot added component/documentation type/chore Something that needs to be done; not a bug or a feature labels Oct 7, 2024
@SungJin1212 SungJin1212 force-pushed the Edit-metadata-cache-supported-values branch from 6b92e6c to 1fd686e Compare October 7, 2024 04:00
@@ -140,7 +140,7 @@ type MetadataCacheConfig struct {
}

func (cfg *MetadataCacheConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string) {
f.StringVar(&cfg.Backend, prefix+"backend", "", fmt.Sprintf("Backend for metadata cache, if not empty. Supported values: %s.", CacheBackendMemcached))
f.StringVar(&cfg.Backend, prefix+"backend", "", fmt.Sprintf("Backend for metadata cache, if not empty. Supported values: %s, %s, and '' (disable).", CacheBackendMemcached, CacheBackendRedis))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just use an array? Then the flag description can just reference that array. It is easier to maintain IMO

Signed-off-by: SungJin1212 <tjdwls1201@gmail.com>
@SungJin1212 SungJin1212 force-pushed the Edit-metadata-cache-supported-values branch from 1fd686e to 60a7b06 Compare October 7, 2024 05:05
@friedrichg friedrichg changed the title [Chore] Edit metadata cache supporrted values description [Chore] Edit metadata cache supported values description Oct 7, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 8, 2024
@yeya24 yeya24 merged commit 417d639 into cortexproject:master Oct 8, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/documentation lgtm This PR has been approved by a maintainer size/S type/chore Something that needs to be done; not a bug or a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants