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

Clarify testing documentation #88

Merged
merged 2 commits into from
Oct 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/src/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The basic idea of the functions is to use `make_test_system` to obtain a
test system, construct an identical system in a downstream library and then use
`test_approx_eq` to check they are actually equal.

For usage examples see the tests of [ExtXYZ](https://github.com/libAtoms/ExtXYZ.jl),
[AtomsIO](https://github.com/mfherbst/AtomIO.jl)
and [ASEconnect](https://github.com/mfherbst/ASEconvert.jl).
For usage examples see the tests of [ExtXYZ](https://github.com/libAtoms/ExtXYZ.jl/blob/master/test/atomsbase.jl),
[AtomsIO](https://github.com/mfherbst/AtomsIO.jl/blob/master/test/xsf.jl),
[Chemfiles](https://github.com/chemfiles/Chemfiles.jl/blob/master/src/atomsbase.jl)
and [ASEconnect](https://github.com/mfherbst/ASEconvert.jl/blob/master/test/runtests.jl).