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

Doc strings #17

Closed
Alex-S-H-P opened this issue May 16, 2023 · 4 comments
Closed

Doc strings #17

Alex-S-H-P opened this issue May 16, 2023 · 4 comments

Comments

@Alex-S-H-P
Copy link

Hi, I can't help but notice that this codebase is quite missing in doc strings.

This really hinders my experience as someone trying to use it. In particular, auto completion does not work.
I know that you've made your documentation on markdown files, and why not, but it does not explain every function that I may want to use.

Is there an ETA on getting those ?
@AmenRa
Copy link
Owner

AmenRa commented May 16, 2023

Hi, sorry for that.
I will add them in the coming days and keep you up-to-date.

@AmenRa
Copy link
Owner

AmenRa commented May 16, 2023

Never mind, I've already added them.

Please, update your installation to version 0.2.1.

Let me know if they are good enough!
Comments and suggestions are more than welcome.

Please consider giving a star to retriv if you like it.

@Alex-S-H-P
Copy link
Author

This is indeed far better. I will test out the new version soon, but thanks for being so reactive !

@AmenRa
Copy link
Owner

AmenRa commented May 17, 2023

Thank you for bringing it to my attention! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AmenRa @Alex-S-H-P