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

Documentation #8

Open
sagebind opened this issue Jun 7, 2017 · 1 comment
Open

Documentation #8

sagebind opened this issue Jun 7, 2017 · 1 comment
Labels
e:medium Effort: Medium
Milestone

Comments

@sagebind
Copy link
Member

sagebind commented Jun 7, 2017

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.

@sagebind sagebind added this to the 1.0.0 milestone Jun 7, 2017
@sagebind sagebind added the ready label Jun 7, 2017
@sagebind sagebind self-assigned this Jun 27, 2017
@twilco
Copy link
Contributor

twilco commented Sep 13, 2018

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.

@sagebind sagebind removed their assignment Oct 3, 2018
@sagebind sagebind added the e:medium Effort: Medium label Oct 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e:medium Effort: Medium
Projects
None yet
Development

No branches or pull requests

2 participants