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

Request for documentation #20

Open
quux00 opened this issue Apr 29, 2014 · 1 comment
Open

Request for documentation #20

quux00 opened this issue Apr 29, 2014 · 1 comment
Assignees

Comments

@quux00
Copy link

quux00 commented Apr 29, 2014

A getting started guide, wiki or annotated set of examples would be very helpful.

Currently, I'm reading through the tests to muddle my way through how to use this library. I see examples on how to use "Generic" Avro, but not "Specific" reader/writers. In particular, you have a "AvroSpecificRecordSerialization" class that seems to be used nowhere in the codebase.

This request for better documentation also goes for the maven plugin you created. It would be much easier to understand what it provides if a few documented examples were included.

@kkrugler
Copy link
Member

kkrugler commented May 3, 2014

Hey Chris - I've added a Javadoc for the AvroSpecificRecordSerialization, to explain why it exists. Would it be possible for you to include a very small Cascading workflow example? I can help annotate & roll it into the docs.

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

3 participants