ParasolJS / parasol-es

ES6 module for interactive visualization of multi-objective optimization problems
https://parasoljs.github.io/
MIT License
26 stars 5 forks source link

Implement JSDoc and Refine API #3

Closed wraseman closed 6 years ago

wraseman commented 6 years ago

Josh, the biggest change I made was implementing JSDoc, which automatically generates documentation for the API. See the /docs directory for examples. I implemented this by adding "docs" to the scripts in the package.json file. The docs can be created by running 'npm run docs'. Not sure if this is the right way to implement it but it seems to work! Other than that, I tried to make the API examples more verbose and tried to fix a couple bugs that I noticed.

Update: I also removed the 'names' column from cars.csv. I also added jsdoc using npm install --save-dev to package.json