derrickoswald / derrickoswald/CIMSpark
Documentation & ScalaDoc
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 19
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the manually generated source files, including CIMRelation options and new CHIM members, along with CIMReader interactive usage and CIMTool generation. The work is done when all generated classes have best-effort ScalaDocs, ScalaDocs are published on github.io, and the interactive usage is split into an INTERACTIVE.md tutorial for spark-shell or Zeppelin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala, spark
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100