docs: Update the missing docstrings on different modules (#911) #1079
Conversation
This file contains 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
Wendong-Fan
reviewed
Oct 20, 2024
There was a problem hiding this comment.
Thanks @MuggleJinx 's great contribution! We need to make each line not exceed 79 characters, could you double check the docstring added?
2 tasks
Wendong-Fan
reviewed
Oct 26, 2024
camel/agents/chat_agent.py
Outdated
Comment on lines
232
to
246
| prompt = f"Use the function '{tool_name}' to '{tool_description}':\n{tool_json}\n" | ||
| prompt = ( |
There was a problem hiding this comment.
no need to change the prompt format here, since it's original prompt from llama https://www.llama.com/docs/model-cards-and-prompt-formats/llama3_1/#user-defined-custom-tool-calling
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
Co-authored-by: Wendong <w3ndong.fan@gmail.com>
Co-authored-by: Guohao Li <lightaime@gmail.com> Co-authored-by: Wendong <w3ndong.fan@gmail.com>
Co-authored-by: Wendong <w3ndong.fan@gmail.com> Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
2 tasks
Wendong-Fan
approved these changes
Oct 30, 2024
There was a problem hiding this comment.
Thanks @MuggleJinx 's great work! LGTM, I think the next step could be review and polish our existing docstrings and close #911
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add Missing Docstrings to Python Modules (#911)
This PR addresses issue #911 by adding the missing docstrings to various Python modules across the codebase. Following the project’s established docstring guidelines, the newly added docstrings enhance code readability, maintainability, and support documentation tools such as Sphinx.
Motivation and Context
Partially resolves issue #911
Types of changes
What types of changes does your code introduce? Put an
xin all the boxes that apply:Implemented Tasks
Checklist
Go over all the following points, and put an
xin all the boxes that apply.If you are unsure about any of these, don't hesitate to ask. We are here to help!