Skip to content

Commit

Permalink
Updated exchange module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Onur R. Bingol committed Mar 29, 2018
1 parent 431a3c1 commit 42f5d47
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions geomdl/exchange.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def save_obj(surf_in=None, file_name=None, **kwargs):
:type file_name: str
Keyword Arguments:
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* *vertex_spacing* (``int``): size of the triangle edge in terms of points sampled on the surface
"""
vertex_spacing = kwargs.get('vertex_spacing', 2)
Expand All @@ -46,8 +46,8 @@ def save_stl(surf_in=None, file_name=None, **kwargs):
:type file_name: str
Keyword Arguments:
binary (bool): True if the saved STL file is going to be in binary format
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* *binary* (``bool``): True if the saved STL file is going to be in binary format
* *vertex_spacing* (``int``): size of the triangle edge in terms of points sampled on the surface
"""
binary = kwargs.get('binary', True)
Expand Down Expand Up @@ -75,8 +75,7 @@ def save_off(surf_in=None, file_name=None, **kwargs):
:type file_name: str
Keyword Arguments:
binary (bool): True if the saved STL file is going to be in binary format
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* *vertex_spacing* (``int``): size of the triangle edge in terms of points sampled on the surface
"""
vertex_spacing = kwargs.get('vertex_spacing', 2)
Expand All @@ -94,8 +93,8 @@ def save_obj_single(surface=None, **kwargs):
:type surface: Abstract.Surface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -146,8 +145,8 @@ def save_obj_multi(surface_list=(), **kwargs):
:type surface_list: Multi.MultiSurface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -229,8 +228,8 @@ def save_stl_ascii_single(surface=None, **kwargs):
:type surface: Abstract.Surface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -273,8 +272,8 @@ def save_stl_ascii_multi(surface_list=(), **kwargs):
:type surface_list: Multi.MultiAbstract
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -329,8 +328,8 @@ def save_stl_binary_single(surface=None, **kwargs):
:type surface: Abstract.Surface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -370,8 +369,8 @@ def save_stl_binary_multi(surface_list=(), **kwargs):
:type surface_list: Multi.MultiAbstract
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -422,8 +421,8 @@ def save_off_single(surface=None, **kwargs):
:type surface: Abstract.Surface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down Expand Up @@ -469,8 +468,8 @@ def save_off_multi(surface_list=(), **kwargs):
:type surface_list: Multi.MultiSurface
Keyword Arguments:
file_name (str): name of the output file
vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
* file_name (str): name of the output file
* vertex_spacing (int): size of the triangle edge in terms of points sampled on the surface
"""
# Get keyword arguments
Expand Down

0 comments on commit 42f5d47

Please sign in to comment.