Skip to content

Documentation & ScalaDoc #13

Open
Open
@derrickoswald

Description

This issue tracks the tasks around documentation in general and ScalaDoc in particular.

  • update manually generated source files (e.g. CIMRelation options, new members of CHIM) to include ScalaDocs for all classes
  • publish ScalaDocs on github.io somewhere
  • update CIMTool to generate 'best-effort' ScalaDoc for generated classes
  • split out CIMReader “interactive usage” as INTERACTIVE.md tutorial using spark-shell or Zeppelin

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions