Skip to content

Commit

Permalink
chore: add missing docstrings for configs 2
Browse files Browse the repository at this point in the history
  • Loading branch information
VsevolodX committed Nov 23, 2024
1 parent 0ab124c commit 5f10743
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/py/mat3ra/made/tools/build/perturbation/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@


class PerturbationConfiguration(BaseModel, InMemoryEntity):
"""
Configuration for a geometrical perturbation.
Args:
material (Material): The Material object.
perturbation_function_holder (PerturbationFunctionHolder): The perturbation function holder.
use_cartesian_coordinates (bool): Whether to use cartesian coordinates
"""

material: Material
perturbation_function_holder: Union[
SineWavePerturbationFunctionHolder, PerturbationFunctionHolder
Expand Down

0 comments on commit 5f10743

Please sign in to comment.