This repository was archived by the owner on Aug 5, 2025. It is now read-only.
fix: the python sdk lacks docstring documentation #149
Conversation
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
Matthieu-OD
approved these changes
Nov 25, 2024
Contributor
Matthieu-OD
left a comment
Matthieu-OD
left a comment
There was a problem hiding this comment.
Really nice work! I try to be as cautious as possible when reviewing docstring
Let's merge
desaxce
deleted the
hugues/eng-2112-the-python-sdk-lacks-docstring-documentation
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes:
To test:
Open your favorite IDE and check you can view documentation for both the sync and async clients APIs / classes
All objects (prompt, dataset, etc. should have documentation). All methods in API should have documentation.
Some formatting issues with Cursor, but it should render well on VSCode at least.