Skip to content

Commit

Permalink
fix doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjonesBSU committed Oct 3, 2023
1 parent e87f075 commit d0af69f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions hoomd_organics/library/surfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@


class Graphene(Compound):
"""Creates a rectangular graphene layer or multiple layers.
"""Create a rectangular graphene layer or multiple layers.
Parameters
----------
x_repeat : int, required
Number of times to repeat graphene lattice in the x-direciton
Number of times to repeat graphene lattice in the x-direciton.
y_repeat: int, required
Number of times to repeat graphene lattice in the y-direciton
Number of times to repeat graphene lattice in the y-direciton.
n_layers: int, optional, default 1
Number of times to repeat the complete layer in the normal direction
Number of times to repeat the complete layer in the normal direction.
periodicity : tuple of bools, length=3, optional, default=(True, True, False) # noqa: E501
Whether the Compound is periodic in the x, y, and z directions.
If None is provided, the periodicity is set to `(False, False, False)`
Expand All @@ -23,7 +23,7 @@ class Graphene(Compound):
Notes
-----
To create bonds along periodic boundaries of the layers in the x and y
directions, set periodicity to (True, True, False)
directions, set `periodicity = (True, True, False)`
"""

Expand Down

0 comments on commit d0af69f

Please sign in to comment.