unleash-client-python icon indicating copy to clipboard operation
unleash-client-python copied to clipboard

UnleashClient.disable_registration isn't documented on the docs

Open CaueP opened this issue 2 years ago • 1 comments

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 avatar Jun 02 '23 13:06 CaueP

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.

ivanklee86 avatar Jun 03 '23 10:06 ivanklee86