Improving The Documentation to match current Scripts

gitdagray / csv-to-sql-insert

Provide table data as a CSV (comma-separated values) file and output a SQL insert statement for a table with the same name as the file.

MIT License

97 stars 122 forks source link

Open Diwanshumidha opened 10 months ago

Diwanshumidha commented 10 months ago

I would like to improve the documentation for the app

m-a-mohsen commented 10 months ago

What about using jsdoc format? ex: `/**

Represents a book.
@constructor
@param {string} title - The title of the book.
@param {string} author - The author of the book. */ function Book(title, author) { }` source: JSDOC

Diwanshumidha commented 10 months ago

Great Idea