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

Add more comments in the source code #3

Open
Satinelamp opened this issue Mar 26, 2022 · 1 comment
Open

Add more comments in the source code #3

Satinelamp opened this issue Mar 26, 2022 · 1 comment

Comments

@Satinelamp
Copy link

Maybe it would be more clear and more understandable if there are more comments in the source code, especially files in the vasp_parser directory.

@Ionizing
Copy link
Owner

You're right. I did it via TDD (test driven development), which means the tests are the best comments. With the benefit of Rust file organization, the tests are bundled with the source code. For example, the tests for Outcar class are on the bottom of outcar.rs and they are very helpful to understand the code. I tried my best to decouple every method and if you have any questions on them, just reply here 😁 and I'll consider adding comments for them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants