Documentation : Updates for Python documentation

This commit is contained in:
Magne Sjaastad
2019-10-25 11:20:27 +02:00
parent 76d196a91a
commit e21e4f5008
5 changed files with 50 additions and 29 deletions

View File

@@ -251,7 +251,12 @@ class Case(PdmObject):
caseId=self.case_id)).createViewResult.viewId)
def contour_maps(self, map_type=ContourMapType.ECLIPSE):
"""Get a list of all contour maps belonging to a project"""
""" Get a list of all contour maps belonging to a project
Arguments:
map_type (enum): ContourMapType.ECLIPSE or ContourMapType.GEO_MECH
"""
pdm_objects = self.descendants(ContourMapType.get_identifier(map_type))
contour_maps = []

View File

@@ -35,6 +35,7 @@ class ContourMap(View):
def export_to_text(self, export_file_name='', export_local_coordinates=False, undefined_value_label="NaN", exclude_undefined_values=False):
""" Export snapshot for the current view
Arguments:
export_file_name(str): The file location to store results in.
export_local_coordinates(bool): Should we export local coordinates, or UTM.