[asterixdb] branch master updated: [ASTERIXDB-2450][DOC] make docs match implementation

[dl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dlych pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/asterixdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 4f87f89  [ASTERIXDB-2450][DOC] make docs match implementation
4f87f89 is described below

commit 4f87f893b57d617279fda7926328ae5b773777a7
Author: Stephen Ermshar <st...@wallawalla.edu>
AuthorDate: Fri Feb 8 13:44:43 2019 -0800

    [ASTERIXDB-2450][DOC] make docs match implementation
    
    details:
    - change site documentation to match function implementation
    - add example for ms_from_day_time_duration
    
    Change-Id: Iacd4cd18b232df7845c80bdb6136f28185193905
    Reviewed-on: https://asterix-gerrit.ics.uci.edu/3153
    Sonar-Qube: Jenkins <je...@fulliautomatix.ics.uci.edu>
    Integration-Tests: Jenkins <je...@fulliautomatix.ics.uci.edu>
    Reviewed-by: Preston Carman <pr...@apache.org>
    Reviewed-by: Dmitry Lychagin <dm...@couchbase.com>
    Tested-by: Dmitry Lychagin <dm...@couchbase.com>
---
 .../asterix-doc/src/main/markdown/builtins/7_temporal.md   | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md b/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
index cee47ba..dd07124 100644
--- a/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
+++ b/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
@@ -157,28 +157,30 @@
 
         year_month_duration("P1Y")
 
-### months_from_year_month_duration/milliseconds_from_day_time_duration ###
+### months_from_year_month_duration/ms_from_day_time_duration ###
 * Syntax:
 
-        months_from_year_month_duration/milliseconds_from_day_time_duration(duration_value)
+        months_from_year_month_duration/ms_from_day_time_duration(duration_value)
 
 * Extracts the number of months or the number of milliseconds from the `duration` subtype.
 * Arguments:
     * `duration_value` : a `duration` of the correct subtype.
 * Return Value:
-    * an `bigint` representing the number or months/milliseconds,
+    * a `bigint` representing the number of months/milliseconds,
     * `missing` if the argument is a `missing` value,
     * `null` if the argument is a `null` value,
     * any other non-duration input value will cause a type error.
 
 * Example:
 
-        months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M")));
-
+        {
+            "months": months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M"))),
+            "milliseconds": ms_from_day_time_duration(get_day_time_duration(duration("P5Y7MT50M")))
+        };
 
 * The expected result is:
 
-        67
+        {"months": 67, "milliseconds": 3000000}
 
 
 ### duration_from_months/duration_from_ms ###