megalut / sewpy

Source Extractor Wrapper for Python
GNU General Public License v3.0
22 stars 11 forks source link

Branch #4, minimal demo script #6

Closed mtewes closed 9 years ago

mtewes commented 9 years ago

As added to README.md, the sphinx generated docs can now be viewed on http://sewpy.readthedocs.org They still look a bit ugly, but I think that we can improve this later. I propose that we don't use apidoc for this small project, but instead hand-write the sphinx input files.

reikonakajima commented 9 years ago

In the sewpy doc, the explanation for __str__() as "trivial" is insufficient. I believe it outputs the workdir information, so we should probably state that.

mtewes commented 9 years ago

OK I fixed the "trivial" explanation, and I've also added RuntimeErrors. Could you run the minimal demo again ? It should fail in a more explicit way... If not, the log file will tell us about what is wrong.

mtewes commented 9 years ago

I'll merge this in a few minutes, as the example itself is probably fine and useful to go ahead. We can keep the branch and the issue to talk about this apparent bug revealed in #4