docs: improve README for developer experience#3
Merged
Conversation
a44b4ab to
10a0eb5
Compare
Comment on lines
49
to
53
| tools["hotdata_create_managed_database"].call( | ||
| name="sales", | ||
| schema_name="public", | ||
| tables="orders", | ||
| tables="orders,customers", | ||
| ) |
There was a problem hiding this comment.
The tables argument is parsed with splitlines() (see hotdata_llamaindex/tools.py:62), not by commas. Passing tables="orders,customers" will create a single table literally named orders,customers rather than two tables.
The existing examples/llamaindex_managed_db.py uses the correct form ("orders\ncustomers"), and the function's docstring also says "one per line". Please update the snippet to match — otherwise users copy-pasting from the README will produce broken managed databases.
Suggested change
| tools["hotdata_create_managed_database"].call( | |
| name="sales", | |
| schema_name="public", | |
| tables="orders", | |
| tables="orders,customers", | |
| ) | |
| tools["hotdata_create_managed_database"].call( | |
| name="sales", | |
| schema_name="public", | |
| tables="orders\ncustomers", | |
| ) |
There was a problem hiding this comment.
Review
Blocking Issues
README.mdlines 49–53: thehotdata_create_managed_databaseexample usestables="orders,customers", but the tool parsestableswithsplitlines()(hotdata_llamaindex/tools.py:62). The comma-separated form creates a single table namedorders,customersinstead of two tables.
Action Required
Change the example to use a newline-separated string ("orders\ncustomers"), matching examples/llamaindex_managed_db.py and the docstring ("one per line").
This file contains hidden or 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
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.
Rewrites the README from a developer experience perspective: