search

shirayu / whispering

Streaming transcriber with whisper
MIT License
685 stars 53 forks source link

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

Open jiangjun0105 opened 1 year ago

jiangjun0105 commented 1 year ago

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 commented 1 year ago

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

shirayu commented 1 year ago

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

github-actions[bot] commented 1 year ago

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