search

jacione / lauepy

Software for scanning Laue diffraction analysis
GNU General Public License v3.0
2 stars 2 forks source link

Documentation needed #8

Open jacione opened 2 years ago

jacione commented 2 years ago

At some point, I need to go through and add docstrings to all of the major functions and files. That would help with collaboration.

jacione commented 2 years ago

There's still a lot of documentation missing from the source code itself, but I just added a pretty hefty README that should at least help people use the software.

cheddacheasy commented 2 years ago

Would you want some help in creating documentation in the source code?

jacione commented 2 years ago

Yes, but not yet. We're currently preparing a publication on this technique for x-ray diffraction analysis. Until that's published, we'd rather keep all contributions within the research group. You're welcome to start if you want (I don't think I'll get around to it so it really would be appreciated), but it may be a couple of months before it gets merged.