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

Lack of documentation on what each function is for. #5

Open
zbrasseaux opened this issue Jun 26, 2019 · 4 comments
Open

Lack of documentation on what each function is for. #5

zbrasseaux opened this issue Jun 26, 2019 · 4 comments

Comments

@zbrasseaux
Copy link

I was looking at the read the docs link and there was very little to actually see, so I decided to go through the code and look through the comments/docstrings, only to find nothing. It's a lot harder to use code when there are no clear indicators what functions are for. I'd be happy to help if you need the assistance, just thought you should know.

@stephenhky
Copy link
Owner

I was looking at the read the docs link and there was very little to actually see, so I decided to go through the code and look through the comments/docstrings, only to find nothing. It's a lot harder to use code when there are no clear indicators what functions are for. I'd be happy to help if you need the assistance, just thought you should know.

Thank you, @zbrasseaux
Yes, we need documentation, but I just do not have time to do so.

I am going to create a branch named readthedocs. Would you fork the repository and add documentation to this branch? You can create PR whenever there is a progress. If you don't have time, you don't have to complete everything.

I appreciate for your help.

@zbrasseaux
Copy link
Author

No problem, I will do through and at least try and write something up for HITS, and maybe more if I get the time.

@stephenhky
Copy link
Owner

Thanks, @zbrasseaux !!

@stephenhky
Copy link
Owner

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

No branches or pull requests

2 participants