add docstrings to Python module

scikit-beam / XrayDB

[ARCHIVED] Atomic data compiled by Elam, Ravel and Sieber. Check https://github.com/xraypy/XrayDB

9 stars 6 forks source link

add docstrings to Python module #10

Closed newville closed 8 years ago

newville commented 8 years ago

also updates to sphinx source generating docs

licode commented 8 years ago

Just some minor comments. LGTM 👍

licode commented 8 years ago

I think xraydb is used a lot in larch and athena? Correct me if I am wrong. We can also add those applications in the doc.

newville commented 8 years ago

@licode right now, larch has its own version -- I'll transition to using the scikit-beam version soon.

Athena / Hephaestus (in Perl) does not (yet?) use the SQLite data. Bruce Ravel (on the Elam tables paper) parsed the ASCII Elam data (and some other tables) into Perl data-structures, and I convinced Darren Dale to first put these into SQLite before using them with Python.