Skip to content
This repository has been archived by the owner on May 1, 2023. It is now read-only.

Would you mind to add a demo video and docstring to functions? #111

Open
jiangjun0105 opened this issue Apr 4, 2023 · 3 comments
Open

Would you mind to add a demo video and docstring to functions? #111

jiangjun0105 opened this issue Apr 4, 2023 · 3 comments
Labels
Status: Stale Type: Question Further information is requested

Comments

@jiangjun0105
Copy link

Description

I really enjoy reading the code which is clean and well formatted. Just it doesn't have any docstring for the function which makes it a little slower for me to understand it. So would you mind adding docstring to the functions so that people can quickly understand what the functions and files are about and potentially start to contribute quickly?
@jiangjun0105 jiangjun0105 added the Type: Question Further information is requested label Apr 4, 2023
@jiangjun0105
Copy link
Author

Also, I feel adding a demo to show readers what they can achieve is also quite helpful.

@shirayu
Copy link
Owner

shirayu commented Apr 4, 2023

Thanks for the suggestion.
Yes I welcome it!
Please send me a pull request.

@github-actions
Copy link

This issue is stale because it has been open for 21 days with no activity.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Status: Stale Type: Question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@shirayu @jiangjun0105