Documentation

[sagebind]

Tabitha is next to useless if it is not documented. At minimum, the following things should be documented:

• Installation
• Row, column, and schema basics
• Creating readers from various formats
• Reader transformations and the reader pipeline
• Writing to an output and pipes
• Concurrent data processing

The initial documentation infrastructure also needs set up. Ideally write in AsciiDoc or Markdown, and generate HTML that can be hosted on GitHub pages.

[twilco]

Something that initially tripped me up with Tabitha was that when utilizing the reader from a RowReaderFactory.open(inStream), the resulting anyRow.header() was returning an empty optional. I incorrectly assumed that Tabitha would populate the header from the file for me, without any action on my part, and was confused when that wasn't happening.

After looking through the available methods on RowReader, I soon discovered that I needed to open my file with RowReaderFactory.open(inStream).withInlineHeaders(). This would be a good thing to make sure we document.