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

[BFCL Chore] Add Unit Test for Valid Func Doc Format #828

Merged
merged 6 commits into from
Dec 13, 2024

Conversation

HuanzhiMao
Copy link
Collaborator

@HuanzhiMao HuanzhiMao commented Dec 11, 2024

This PR adds a unit test to check for the correct function doc format. For example, a required parameter should not have a 'default' field.

Below is the output, which indicates potential issues that need to be addressed (they will be fixed in separate PRs).

# python check_func_doc_format.py 
--------------------
Entry ID: exec_multiple_45
Function: book_room
Error: The parameter 'room_type' is of type 'dict' and should contain either 'properties' or 'additionalProperties' field to specify the sub-parameters details.
...

@HuanzhiMao HuanzhiMao added the BFCL-General General BFCL Issue label Dec 11, 2024
Copy link
Collaborator

@Fanjia-Yan Fanjia-Yan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Remove Commented Code.
  • Add instruction to run it on PR description
  • List out all possible error cases that could be caught either in codebase or PR description
    Other than that LGTM

Copy link
Collaborator

@Fanjia-Yan Fanjia-Yan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HuanzhiMao HuanzhiMao merged commit 4aae980 into ShishirPatil:main Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BFCL-General General BFCL Issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants