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

Add a warning message if docs_path not explicitly set #814

Merged
merged 6 commits into from
Nov 30, 2023

Conversation

thinkall
Copy link
Collaborator

Why are these changes needed?

Address https://discord.com/channels/1153072414184452236/1153072414184452241/1179080685407973447

I wish "docs_path" : False/None was mandatory when docs are not specified.. doesnt the zen of Python say something about explicity > implicity? Turns out that if I have a typo in my retrieve_config the error that I get for not defining docs_path doenst help at all

Related issue number

Checks

@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (f654946) 27.79% compared to head (795f264) 37.22%.

Files Patch % Lines
...gen/agentchat/contrib/retrieve_user_proxy_agent.py 33.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #814      +/-   ##
==========================================
+ Coverage   27.79%   37.22%   +9.43%     
==========================================
  Files          27       27              
  Lines        3497     3500       +3     
  Branches      793      794       +1     
==========================================
+ Hits          972     1303     +331     
+ Misses       2454     2077     -377     
- Partials       71      120      +49     
Flag Coverage Δ
unittests 37.17% <33.33%> (+9.43%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@qingyun-wu qingyun-wu left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks Li!

@qingyun-wu qingyun-wu added this pull request to the merge queue Nov 30, 2023
Merged via the queue into main with commit ae7066b Nov 30, 2023
68 of 71 checks passed
@thinkall thinkall deleted the warn_docs_path branch December 1, 2023 02:23
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* Add a warning message if docs_path not explicitly set

* update

* Add how to suppress warning message

* Fix tests errors

* Fix tests errors

* Fix tests errors
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.

3 participants