Commit 85a6a3be authored by Jason Swails's avatar Jason Swails
Browse files

Clarify a docstring.

parent 31f09353
...@@ -734,15 +734,11 @@ class ProteinStructure(object): ...@@ -734,15 +734,11 @@ class ProteinStructure(object):
Sets the periodic box boundary conditions. Sets the periodic box boundary conditions.
Parameters: Parameters:
- box (list of 6 floats) : A list of 6 numbers representing a, b, c, - lengths (list of 3 distances) : A sequence of 3 distances that
alpha, beta, and gamma, respectively (box lengths and angles). represent the lengths of the periodic box vectors
If None, the system is assumed to be aperiodic - angles (list of 3 angles) : A list of 3 angle measurements between
Notes: the periodic box vectors. Default is 90 degrees if lengths
The box can alternatively be a list of 3 numbers representing the is not None
box lengths. In this case, the angles are assumed to be 90 degrees
The box here is copied via slicing, so changing the box that was
passed in will have no effect after set_box is called.
""" """
if len(lengths) != 3: if len(lengths) != 3:
raise ValueError('set_box requires 3 box lengths') raise ValueError('set_box requires 3 box lengths')
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment