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

This adds documentation #5

Merged
merged 3 commits into from Jun 26, 2012

Conversation

paulproteus
Copy link

http://oh-bugimporters.readthedocs.org/en/latest/ is them on the web. (Once this moves to master, then I will adjust readthedocs to point at the official repo, not at my fork.)

Please review! If someone says it's good, I will push it. If there are things to fix, I will fix them.

@aldeka
Copy link

aldeka commented Jun 26, 2012

Good start. Could be more specific about what BugImporter and BugParser require and expect--maybe walk through the github example further?

@paulproteus
Copy link
Author

The difficulty is that it's very specific to each BugParser.

The Google code issues importer doesn't even have a BugParser, shockingly (I just noticed this a few min ago).

OK if that's a follow-on set of changes?

@paulproteus
Copy link
Author

Further thought: The best way to do the Github one is to link to docstrings in the class, but I don't know how to do that yet in Sphinx.

@aldeka
Copy link

aldeka commented Jun 26, 2012

Fair enough. Each parser should probably have its own documentation, but that can wait.

Noting that Google's is an exception (so people aren't confused why they can't find its BugParser) is probably wise.

Beyond that, let's ship it.

@paulproteus
Copy link
Author

I'll add a commit on top for the Google exception, then ship.

@paulproteus paulproteus merged commit eacc608 into openhatch:master Jun 26, 2012
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

Successfully merging this pull request may close these issues.

None yet

2 participants