Skip to content

Commit 61c2aab

Browse files
committed
Update shortcuts module docstrings
1 parent 2e90fbe commit 61c2aab

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

geomdl/shortcuts.py

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,49 +3,65 @@
33
:platform: Unix, Windows
44
:synopsis: Provides shortcut functions for creating new instances of the geomdl classes
55
6-
.. moduleauthor:: Onur Rauf Bingol <orbingol@gmail.com>
6+
.. moduleauthor:: Onur R. Bingol <contact@onurbingol.net>
77
88
"""
99

10-
from . import BSpline
11-
from . import NURBS
12-
from . import multi
13-
from . import freeform
10+
from . import BSpline, NURBS, multi, freeform
1411

1512

1613
# Initialize an empty __all__ for controlling imports
1714
__all__ = []
1815

1916

2017
def generate_curve(rational=False):
18+
""" Returns a curve instance
19+
20+
:param rational: if True, returns a rational curve instance
21+
:type rational: bool
22+
"""
2123
if rational:
2224
return NURBS.Curve()
2325
return BSpline.Curve()
2426

2527

2628
def generate_surface(rational=False):
29+
""" Returns a surface instance
30+
31+
:param rational: if True, returns a rational surface instance
32+
:type rational: bool
33+
"""
2734
if rational:
2835
return NURBS.Surface()
2936
return BSpline.Surface()
3037

3138

3239
def generate_volume(rational=False):
40+
""" Returns a volume instance
41+
42+
:param rational: if True, returns a rational volume instance
43+
:type rational: bool
44+
"""
3345
if rational:
3446
return NURBS.Volume()
3547
return BSpline.Volume()
3648

3749

3850
def generate_freeform():
51+
""" Returns a freeform instance """
3952
return freeform.Freeform()
4053

4154

4255
def generate_container_curve():
56+
""" Returns a curve container instance """
4357
return multi.CurveContainer()
4458

4559

4660
def generate_container_surface():
61+
""" Returns a surface container instance """
4762
return multi.SurfaceContainer()
4863

4964

5065
def generate_container_volume():
66+
""" Returns a volume container instance """
5167
return multi.VolumeContainer()

0 commit comments

Comments
 (0)