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 documentation for Assistant #2293

Closed
wants to merge 3 commits into from
Closed

Add documentation for Assistant #2293

wants to merge 3 commits into from

Conversation

misscoded
Copy link
Contributor

Summary

Adds accompanying documentation for Assistant class. Initial commit is based off of the Python documentation, but needn't stay that way.

Requirements (place an x in each [ ])

@misscoded misscoded added the docs M-T: Documentation work only label Oct 17, 2024
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.21%. Comparing base (1ebd657) to head (f38748d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2293   +/-   ##
=======================================
  Coverage   81.21%   81.21%           
=======================================
  Files          21       21           
  Lines        1799     1799           
  Branches      498      498           
=======================================
  Hits         1461     1461           
  Misses        218      218           
  Partials      120      120           

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

@misscoded
Copy link
Contributor Author

@lukegalbraithrussell 👋🏼 Initial draft, based on the Python version that was published. Feel free to make use of this branch for any additional changes you see fit. It's in your hands now!

@misscoded
Copy link
Contributor Author

Closing this as #2295 has been opened instead for the same purpose.

@misscoded misscoded closed this Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants