search

openhatch / oh-bugimporters

Bug importers for the OpenHatch project oh-mainline
https://oh-bugimporters.readthedocs.org/
GNU Affero General Public License v3.0
12 stars 28 forks source link

This adds documentation #5

Closed paulproteus closed 12 years ago

paulproteus commented 12 years ago

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 commented 12 years ago

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

paulproteus commented 12 years ago

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 commented 12 years ago

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 commented 12 years ago

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 commented 12 years ago

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