-
Notifications
You must be signed in to change notification settings - Fork 31
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
Improve Docstrings #69
base: master
Are you sure you want to change the base?
Conversation
I don't know if @happyleavesaoc wants to merge this, but there are many unrelated changes like replacing single quotes with double quotes and even some code changes. |
I was trying to minimize the code changes but sometimes it would say that the code changed but after checking the original version the code was the same with the same indentation |
Hello, I'm interested in accepting a PR with some docstring updates, but I think the following would be necessary:
|
I'll keep it in mind and try to update the pr with these fixes |
@happyleavesaoc Should i open a new pr with only the new docstrings or just update this one? |
@chicco-carone either way is fine |
If there are any issues with the pr so that it can't be merged just let me know and i'll try to fix them |
I'm currently making an application which uses this library but i was having trouble when testing with what every function did, so i added into the docstring for all the functions what are the arguments and what they are used for and if the function retuns anything i added that too. All the docstrings were generated with github copilot but i checked all of them.