From 9433d31b56ea0dfe49285e984a6a9b8b829beb0c Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Tue, 19 May 2020 21:28:12 -0700 Subject: [PATCH 1/2] Update pycmap_histogram.rst Megan's edits and comments --- .../pycmap_api/data_vizualization/pycmap_histogram.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst index b73e727..1f5ff6b 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst @@ -26,6 +26,7 @@ Histogram Plot Creates a histogram graph for each variable according to the specified space-time constraints (dt1, dt2, lat1, lat2, lon1, lon2, depth1, depth2). Change the `APIs vizEngine`_ parameter if you wish to use a different visualization library. Returns the generated graph objects in form of a python list. One may use the returned objects to modify the graph properties. +..COMMENT: Are you sure the hyperlink above is directing the user to the right page? Doesn't make sense to me why it's directing me to where it is. Do you want it directing the user to the 'API' method page? .. note:: This method requires a valid `API key`_. It is not necessary to set the @@ -61,6 +62,8 @@ Histogram Plot **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: Are you sure the hyperlink above is directing the user to the right page? Doesn't make sense to me why it's directing me to where it is. Do you want it directing the user to the 'API' method page? + **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. @@ -146,7 +149,7 @@ visualization library (plotly) which may be changed by: - +..COMMENT: Maybe I commented on this before but I would add example plots below showing what the lines are doing to change the above plots. .. code-block:: python From 0da5b140a91ad7115fb3a91817b3ee5dac2cfb5c Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 27 May 2020 21:53:23 -0700 Subject: [PATCH 2/2] Update pycmap_histogram.rst --- .../pycmap_api/data_vizualization/pycmap_histogram.rst | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst index 1f5ff6b..9d03973 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst @@ -26,8 +26,6 @@ Histogram Plot Creates a histogram graph for each variable according to the specified space-time constraints (dt1, dt2, lat1, lat2, lon1, lon2, depth1, depth2). Change the `APIs vizEngine`_ parameter if you wish to use a different visualization library. Returns the generated graph objects in form of a python list. One may use the returned objects to modify the graph properties. -..COMMENT: Are you sure the hyperlink above is directing the user to the right page? Doesn't make sense to me why it's directing me to where it is. Do you want it directing the user to the 'API' method page? - .. note:: This method requires a valid `API key`_. It is not necessary to set the API key every time because the API properties are stored locally after @@ -61,9 +59,6 @@ Histogram Plot 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: Are you sure the hyperlink above is directing the user to the right page? Doesn't make sense to me why it's directing me to where it is. Do you want it directing the user to the 'API' method page? - **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. @@ -98,7 +93,7 @@ Histogram Plot | -**Example 1:** +**Example 1** This example creates three histogram graphs comparing dissolved oxygen @@ -149,8 +144,6 @@ visualization library (plotly) which may be changed by: -..COMMENT: Maybe I commented on this before but I would add example plots below showing what the lines are doing to change the above plots. - .. code-block:: python # here is how to modify a graph: