Skip to content

Klient.Resources.List function documentation incorrectly states namespace as supported argument #503

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

Open
kraashen opened this issue Apr 30, 2025 · 0 comments
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@kraashen
Copy link

kraashen commented Apr 30, 2025

What happened?

In the klient documentation, the List() function call signature is specified as

func (_ Resource) List(ctx context.Context, namespace string, l ObjectList, opts ...ListOption) error

along with the provided examples following this implementation. But in the code, it is used otherwise:

func (r *Resources) List(ctx context.Context, objs k8s.ObjectList, opts ...ListOption) error {
...

Going through the examples' code, it seems that the List() function is used in the latter manner.

What did you expect to happen?

Documentation matches the implementation.

How can we reproduce it (as minimally and precisely as possible)?

N/A

Anything elese we need to know?

No response

E2E Provider Used

kind

e2e-framework Version

0.6.0

OS version

No response

@kraashen kraashen added the kind/bug Categorizes issue or PR as related to a bug. label Apr 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

1 participant