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

fix: the python sdk lacks docstring documentation #149

Merged

Conversation

desaxce
Copy link
Collaborator

@desaxce desaxce commented Nov 20, 2024

Changes:

  • made all doc part of BaseLiteralAPI so async versions get doc (previous hack with doc didn't work at all)
  • added typing to all APIs
  • reworded all the documentation
  • fixed misalignments between sync and async clients

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.

@Matthieu-OD Matthieu-OD self-requested a review November 25, 2024 14:51
Copy link
Contributor

@Matthieu-OD Matthieu-OD left a comment

Choose a reason for hiding this comment

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

Really nice work! I try to be as cautious as possible when reviewing docstring

Let's merge

@desaxce desaxce merged commit f657996 into main Nov 25, 2024
2 checks passed
@desaxce desaxce deleted the hugues/eng-2112-the-python-sdk-lacks-docstring-documentation branch November 25, 2024 15:19
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.

2 participants