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

Better documentation of parameters for chatbot_config and client_config #33

Open
yichern opened this issue Nov 2, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@yichern
Copy link
Contributor

yichern commented Nov 2, 2022

In configure_chatbot

def configure_chatbot(self, chatbot_config: Dict = {}) -> None:
"""Configures chatbot options.
Args:
chatbot_config (Dict, optional): Updates self.chatbot_config. Defaults
to {}.
"""

and configure_client

def configure_client(self, client_config: Dict = {}) -> None:
"""Configures client options.
Args:
client_config (Dict, optional): Updates self.client_config. Defaults to {}.
"""

We should better specify what each parameter is

@yichern yichern added the documentation Improvements or additions to documentation label Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant