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

Append wrongly named / Missing docs #617

Open
PrivatePuffin opened this issue Oct 24, 2024 · 2 comments
Open

Append wrongly named / Missing docs #617

PrivatePuffin opened this issue Oct 24, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@PrivatePuffin
Copy link

Spegel version

All

Kubernetes distribution

Irrelevant

Kubernetes version

Irrelevant

CNI

Irrelevant

Describe the bug

The Append function for mirrors seems to be incorrectly named.
I've gone over the tests and seen what it actually does.

Technically its a prepend, add before something else, not an append

As breaking the naming now is annoying, this should at least be very clearly documented.

@PrivatePuffin PrivatePuffin added the bug Something isn't working label Oct 24, 2024
@phillebaba
Copy link
Member

This is true. Reading the docs for the value it is a bit confusing.

When true existing mirror configuration will be appended to instead of replaced.

What I tried to communicate is that existing mirrors are appended to the the mirror configuration. Maybe appendExistingMirrors would be a better name.

@phillebaba phillebaba added documentation Improvements or additions to documentation and removed bug Something isn't working labels Oct 29, 2024
@PrivatePuffin
Copy link
Author

This is true. Reading the docs for the value it is a bit confusing.

When true existing mirror configuration will be appended to instead of replaced.

Its mostly a docs issue x will be appended, means that Y is added below X.
In this case "existing mirror configuration" will be appended, means that "spegel" is added below "existing mirror configuration"

So the issue is mostly the fact that this sentence is wrong.
Keeping the same kind of sentence, the correct way to write this would be:

When true existing mirror configuration will be appended to the spegel mirror configuration

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants