Skip to content

Added missing docstrings in admin/client.py #2487

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

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Conversation

lukalafaye
Copy link
Contributor

Added missing doc strings for the following methods:

_convert_new_topic_request
list_topics
describe_topics
describe_cluster
_convert_describe_acls_response_to_acls
_convert_create_acls_resource_request_v0
_convert_create_acls_resource_request_v1
_convert_create_acls_response_to_acls
_convert_delete_acls_resource_request_v0
_convert_delete_acls_resource_request_v1
_convert_delete_acls_response_to_matching_acls
_convert_describe_config_resource_request
_convert_alter_config_resource_request
_convert_create_partitions_request
_convert_delete_groups_response
_delete_consumer_groups_send_request
_wait_for_futures

Added missing doc strings for the following methods:

_convert_new_topic_request
list_topics
describe_topics
describe_cluster
_convert_describe_acls_response_to_acls
_convert_create_acls_resource_request_v0
_convert_create_acls_resource_request_v1
_convert_create_acls_response_to_acls
_convert_delete_acls_resource_request_v0
_convert_delete_acls_resource_request_v1
_convert_delete_acls_response_to_matching_acls
_convert_describe_config_resource_request
_convert_alter_config_resource_request
_convert_create_partitions_request
_convert_delete_groups_response
_delete_consumer_groups_send_request
_wait_for_futures
@dpkp
Copy link
Owner

dpkp commented Feb 21, 2025

Can we use the same style docstrings as in the rest of the codebase? I'm not sure how admin code got started with this format. See https://google.github.io/styleguide/pyguide.html#383-functions-and-methods (though we've got Arguments instead of Args)

@dpkp dpkp merged commit b5985b4 into dpkp:master Feb 21, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants