Fixed minor documentation errors #3

Merged
merged 1 commit into from Apr 17, 2012

Conversation

Projects
None yet
2 participants
@sork
Contributor

sork commented Apr 17, 2012

I noticed that two method names were wrong in the documentation.

jeremyckahn added a commit that referenced this pull request Apr 17, 2012

Merge pull request #3 from sork/docs-fixes
Fixed minor documentation errors

@jeremyckahn jeremyckahn merged commit 6a85602 into jeremyckahn:master Apr 17, 2012

@jeremyckahn

This comment has been minimized.

Show comment Hide comment
@jeremyckahn

jeremyckahn Apr 17, 2012

Owner

Awesome! Realistically, I should find an automated solution for generating the docs to prevent errors like this. There are a number of options out there, but I don't love any of them. Also, I'd need to make a lot of changes to the current annotations to use any of the tools.

I'll get to it at some point down the road, but there are higher priorities at the moment. Thanks for the Pull Request!

Owner

jeremyckahn commented Apr 17, 2012

Awesome! Realistically, I should find an automated solution for generating the docs to prevent errors like this. There are a number of options out there, but I don't love any of them. Also, I'd need to make a lot of changes to the current annotations to use any of the tools.

I'll get to it at some point down the road, but there are higher priorities at the moment. Thanks for the Pull Request!

@sork

This comment has been minimized.

Show comment Hide comment
@sork

sork Apr 17, 2012

Contributor

You're welcome. I agree that auto-generated documentation would probably be the best approach in order to avoid this kind of issues. I don't have any option to recommend though.

Contributor

sork commented Apr 17, 2012

You're welcome. I agree that auto-generated documentation would probably be the best approach in order to avoid this kind of issues. I don't have any option to recommend though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment