Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make comments jsdoc compatible #19

Open
6 tasks done
henridf opened this issue Dec 1, 2015 · 5 comments
Open
6 tasks done

Make comments jsdoc compatible #19

henridf opened this issue Dec 1, 2015 · 5 comments

Comments

@henridf
Copy link
Owner

henridf commented Dec 1, 2015

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

  • DataFrame.js
  • DataFrameReader.js
  • GroupedData.js
  • functions.js
  • sqlContext.js
  • Column.js

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

@henridf
Copy link
Owner Author

henridf commented Dec 5, 2015

Note that (as of 1497125) 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
Copy link
Owner Author

henridf commented Dec 7, 2015

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
Copy link
Owner Author

henridf commented Dec 7, 2015

lib/sqlContext.js done in 1497125 and 81be036

lib/DataFrameReader.js done in c73dbdc

lib/GroupedData.js done in bdf9d1d

@henridf
Copy link
Owner Author

henridf commented Dec 7, 2015

lib/functions.js done in b30df94

@henridf
Copy link
Owner Author

henridf commented Dec 17, 2015

lib/Column.js docs done in da6c0cd and db2f67e

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant