Add JSDocs or other type of documentation.

SwapnikKatkoori / node-summarizer

A simple node module that allows users to summarize text

ISC License

43 stars 17 forks source link

Add JSDocs or other type of documentation. #8

Open SwapnikKatkoori opened 5 years ago

SwapnikKatkoori commented 5 years ago

The code could really use some documentation to be easier to maintain.

caelinsutch commented 4 years ago

Is this project still maintained?

SwapnikKatkoori commented 4 years ago

As of right now, not really :(

caelinsutch commented 4 years ago

I'm probably going to start working with this, as of now everything is working properly? Are there typescript definitions written as well? I'll probably write some JSdocs and typescript definitions if needed.

SwapnikKatkoori commented 4 years ago

Yes, as of right now I believe everything works except for a bug that a user found in wordpos(issue 12). I haven't really had a chance to look at this yet.