Skip to content

Commit

Permalink
chore: docstring 2
Browse files Browse the repository at this point in the history
  • Loading branch information
VsevolodX committed Sep 25, 2024
1 parent 13bac90 commit 72c9bdd
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/py/mat3ra/made/tools/build/grain_boundary/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ def create_grain_boundary(
configuration: GrainBoundaryConfiguration,
builder: Optional[GrainBoundaryBuilder] = None,
) -> Material:
"""
Create a grain boundary according to provided configuration with selected builder.
Args:
configuration (GrainBoundaryConfiguration): The configuration of the grain boundary.
builder (Optional[GrainBoundaryBuilder]): The builder to use for creating the grain boundary.
Returns:
Material: The material with the grain boundary.
"""
if builder is None:
builder = GrainBoundaryBuilder()
return builder.get_material(configuration)

0 comments on commit 72c9bdd

Please sign in to comment.