docs: add docstring to setup_kubearchive_client()#151
Open
AshleyAHuang wants to merge 1 commit into
Open
Conversation
setup_kubearchive_client() is the entry point for initializing the cached KubeArchive client singleton, but had no docstring — callers couldn't tell what the parameters expect, that it returns None on discovery failure, or that results are cached in the module-level ka_client global.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #122.
setup_kubearchive_client()is the entry point forinitializing the cached KubeArchive client singleton, but had no
docstring — callers couldn't tell what the parameters expect, that it
returns None on discovery failure, or that results are cached in the
module-level
ka_clientglobal.Docstring matches the Google-style convention already used elsewhere in
this file (checked against KubeArchiveEndpointDiscovery.discover_endpoint
and KubeArchiveClient.init). No behavior change.