Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align formatting of annotations #248

Closed
fad3t opened this issue Mar 20, 2024 · 4 comments
Closed

Align formatting of annotations #248

fad3t opened this issue Mar 20, 2024 · 4 comments

Comments

@fad3t
Copy link

fad3t commented Mar 20, 2024

What

This may sound a bit stupid, but I'm wondering if we could align the formatting of the different annotations.
Some use hyphens (inodes-threshold, initial-resize-group-by, ..) while other use underscores (storage_limit, pre_capacity_bytes), which can be confusing.
The standard seems to be hyphens from what I've seen.

How

Update the few annotations that use underscores and replaces them with hyphens.
We might want to support both for some time to avoid breaking changes?

If you're OK with the idea, I'd be happy to contribute.

@peng225 peng225 moved this from To do to In progress in Development Mar 21, 2024
@pluser
Copy link
Contributor

pluser commented Mar 22, 2024

Thanks for the suggestion!
However, I am hesitant to change the annotation key. Especially for the parts that are directly changed by the user, I'm concerned about the possibility of embedding a bug.
Do you have any further suggestions that you think should be changed?

@fad3t
Copy link
Author

fad3t commented Mar 22, 2024

Hi,
I understand this might be tricky to change, that's why I was suggesting to support both for some time — plus this would need to be carefully tested.
I've just started using the controller, so I'll share some more improvements once I'm a bit more experimented ;)

@pluser
Copy link
Contributor

pluser commented Mar 25, 2024

Hmmm. I think we can change it for some internal names. But changing the external interface is risky and I would like to keep it as is.

@fad3t
Copy link
Author

fad3t commented Mar 25, 2024

Never mind, this was just a suggestion, it's OK if you don't feel like changing it. Thx for the feedback.

@fad3t fad3t closed this as completed Mar 25, 2024
@github-project-automation github-project-automation bot moved this from In progress to Done in Development Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants