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

Documentation needed #8

Open
jacione opened this issue May 24, 2022 · 3 comments
Open

Documentation needed #8

jacione opened this issue May 24, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@jacione
Copy link
Owner

jacione commented May 24, 2022

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 jacione added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 24, 2022
@jacione
Copy link
Owner Author

jacione commented Jul 19, 2022

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.

Repository owner deleted a comment from cheddacheasy Jul 19, 2022
@cheddacheasy
Copy link

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

@jacione
Copy link
Owner Author

jacione commented Jul 19, 2022

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.

@jacione jacione removed the good first issue Good for newcomers label Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants