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

Improve Docstrings #69

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

chicco-carone
Copy link

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.

@luar123
Copy link
Contributor

luar123 commented May 30, 2024

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.

@chicco-carone
Copy link
Author

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

@happyleavesaoc
Copy link
Owner

Hello, I'm interested in accepting a PR with some docstring updates, but I think the following would be necessary:

  1. no unrelated style changes (this will make your diff a lot more legible)
  2. docstrings should be value-add rather than a restatement of the code - for example, setters and getters don't need explanation
  3. avoid class-level enumeration of attributes and methods (harder to maintain)
  4. type info should be in the form of type hints

@chicco-carone
Copy link
Author

I'll keep it in mind and try to update the pr with these fixes

@chicco-carone
Copy link
Author

@happyleavesaoc Should i open a new pr with only the new docstrings or just update this one?

@happyleavesaoc
Copy link
Owner

@chicco-carone either way is fine

@chicco-carone
Copy link
Author

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

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.

3 participants