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

UnleashClient.disable_registration isn't documented on the docs #255

Open
CaueP opened this issue Jun 2, 2023 · 1 comment
Open

UnleashClient.disable_registration isn't documented on the docs #255

CaueP opened this issue Jun 2, 2023 · 1 comment
Assignees

Comments

@CaueP
Copy link

CaueP commented Jun 2, 2023

Describe the bug
I was reading the docs of UnleashClient and noticed that the disable_registration parameter doesn't have a description (code reference). What does it do?

To Reproduce
Steps to reproduce the behavior:

  1. Go to the docs (https://docs.getunleash.io/unleash-client-python/unleashclient.html) or code
  2. Search for disable_registration parameter
  3. You'll see it's only on the class signature, but not on the parameters descriptions

Expected behavior
I expected to see a description of what it does on the description page.

@CaueP CaueP changed the title UnleashClient.disable_registration isn't explained on the docs UnleashClient.disable_registration isn't documented on the docs Jun 2, 2023
@ivanklee86
Copy link
Collaborator

Whoops! There's actually a PR for fixing the docstring. (I need to see why unit tests are being cranky.)

disable_registration sends metadata to the Unleash server on Unleash Client startup. The main use case is Gitlab's Unleash integration which doesn't support registration.

@nunogois nunogois moved this from New to Todo in Issues and PRs Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

2 participants