Skip to content

Commit c83d5d5

Browse files
committed
Improve doc of pymatgen.util.testing.
1 parent 4542689 commit c83d5d5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

pymatgen/util/testing/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
"""Common test support for pymatgen test scripts.
1+
"""This module implements testing utilities for materials science codes.
22
3-
This single module should provide all the common functionality for pymatgen
4-
tests in a single location, so that test scripts can just import it and work
5-
right away.
3+
While the primary use is within pymatgen, the functionality is meant to be useful for external materials science
4+
codes as well. For instance, obtaining example crystal structures to perform tests, specialized assert methods for
5+
materials science, etc.
66
"""
77

88
from __future__ import annotations

0 commit comments

Comments
 (0)