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.

Sign up for GitHub

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

Jump to bottom

Feat: Clean up public API and improve docs #109

Merged
merged 4 commits into from
Mar 8, 2024
Merged

Feat: Clean up public API and improve docs #109

merged 4 commits into from
Mar 8, 2024

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Mar 8, 2024 •
edited
Loading

Resolves #22

This cleans up the public API while improving docs readability and coverage.

@aaronsteers
Copy link
Contributor Author

https://www.loom.com/share/3abe276bc44241259f951f910fbf54a5?sid=d0403b50-1180-447f-8075-f012519a4527

bindipankhudi
bindipankhudi approved these changes Mar 8, 2024
View reviewed changes
Copy link
Contributor

@bindipankhudi bindipankhudi left a comment

Choose a reason for hiding this comment

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

All makes sense to me. (I watched the Loom). Docs are looking great! It's really cool that we can update usage section in docs by updating in code!

@aaronsteers aaronsteers merged commit 5cbde18 into main Mar 8, 2024
12 checks passed
@aaronsteers aaronsteers deleted the aj/clean-up-public-api branch March 8, 2024 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bindipankhudi bindipankhudi bindipankhudi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clean up public interface
2 participants
@aaronsteers @bindipankhudi