From e3631b9e185a3fb17954a7c27c78e46e4d82fc96 Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 20 May 2020 14:47:51 -0700 Subject: [PATCH 1/2] Update pycmap_depth_profile.rst Megan's edits and comments --- .../pycmap_api/data_vizualization/pycmap_depth_profile.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst index 90c4705..f70699b 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst @@ -37,6 +37,7 @@ Depth Profile python list. One may use the returned objects to modify the graph properties. +..COMMENT: I think you want the above hyperlink to direct user to the API methods page. .. note:: This method requires a valid `API key`_. It is not necessary to set the @@ -72,6 +73,8 @@ Depth Profile **exportDataFlag: boolean, default: False** If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_. +..COMMENT: I think you want the above hyperlink to go to the API methods page instead. + **show: boolean, default: True** If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory. If False, the graph object is returned but not displayed. @@ -79,9 +82,9 @@ Depth Profile - :returns: list of graph objects + :returns: A list of graph objects. - A list of graph objects. Below are the graph's properties and methods. + Below are the graph's properties and methods. :Properties: **data: dataframe** From 6d7573b899291d8532285eafde755825c37f9d9a Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 27 May 2020 22:05:19 -0700 Subject: [PATCH 2/2] Update pycmap_depth_profile.rst --- .../pycmap_api/data_vizualization/pycmap_depth_profile.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst index f70699b..cbe3192 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst @@ -72,9 +72,6 @@ Depth Profile End depth [m]. This parameter sets the upper bound of the vertical cut. Note depth is a positive number (it is 0 at the surface and increases towards the ocean floor). **exportDataFlag: boolean, default: False** If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_. - -..COMMENT: I think you want the above hyperlink to go to the API methods page instead. - **show: boolean, default: True** If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory. If False, the graph object is returned but not displayed. @@ -110,7 +107,7 @@ Depth Profile | -Example: +Example -------- This example compares the depth profile of chlorophyll concentration @@ -173,7 +170,7 @@ Here is how to achieve the same results using a direct SQL statement. Please ref EXEC uspDepthProfile 'tableName', 'variable', 'dt1', 'dt2', 'lat1', 'lat2', 'lon1', 'lon2', 'depth1', 'depth2' -**Example:** +**Example** .. code-block:: sql