apache-spark-node icon indicating copy to clipboard operation
apache-spark-node copied to clipboard

Make comments jsdoc compatible

Open henridf opened this issue 10 years ago • 5 comments

Similar to what was done in #18 for lib/DataFrame.js in 9675dd35bbff8ab5bc0ede5b1755981ab1666208, but for the other API wrappers in lib/

  • [x] DataFrame.js
  • [x] DataFrameReader.js
  • [x] GroupedData.js
  • [x] functions.js
  • [x] sqlContext.js
  • [x] Column.js

Row.js doesn't need to be documented (at least yet) -- it is only used internally so far.

henridf avatar Dec 01 '15 03:12 henridf

Note that (as of 149712572280c65682af48ed0e6e76ce637d44de) jsdoc creates docs for the class SQLContext and its constructor, which isn't accessible outside of sqlContext.js. Need to figure out how to address this.

henridf avatar Dec 05 '15 06:12 henridf

Also need to make a pass to do something about the backticks in comments as they currently just add noise. One option is to remove them, another is to replace them by , and another is to leave them and look into using the markdown plugin.

henridf avatar Dec 07 '15 06:12 henridf

lib/sqlContext.js done in 149712572280c65682af48ed0e6e76ce637d44de and 81be03622047bd78b249316ab7b9d7fe8f3644d8

lib/DataFrameReader.js done in c73dbdc6ce189db3152c719d4b5c7739b138351f

lib/GroupedData.js done in bdf9d1d5830f2507ea96e4d0290397440dc0ab6e

henridf avatar Dec 07 '15 06:12 henridf

lib/functions.js done in b30df948ca88b095f11d96c60244af9f76a01352

henridf avatar Dec 07 '15 19:12 henridf

lib/Column.js docs done in da6c0cd515381ba589e6f906e38bf7b32f16e2e5 and db2f67eeff8610e22f0278e1527ca77e70b29730

henridf avatar Dec 17 '15 20:12 henridf