From 1251f70aa3442736ce6fd9c4fb7fbce412af5a52 Mon Sep 17 00:00:00 2001
From: Sunil Shetye
Date: Wed, 25 Jul 2018 17:11:09 +0530
Subject: code changes by Kartik Hegde during FOSSEE Fellowship 2018

---
 help/en_US/cummax.xml | 34 ++++++++++++++++++++--------------
 1 file changed, 20 insertions(+), 14 deletions(-)

(limited to 'help/en_US/cummax.xml')

diff --git a/help/en_US/cummax.xml b/help/en_US/cummax.xml
index 76c863a..e385ac0 100644
--- a/help/en_US/cummax.xml
+++ b/help/en_US/cummax.xml
@@ -25,32 +25,42 @@
    <title>Calling Sequence</title>
    <synopsis>
    M = cummax(A)
-   returns the cumulative maximum of the arguments of A. The dimension
-   of M is same as the dimension of A. If A is a 2D matrix, the operation
-   is performed along the columns. For a hypermatrix, the operation is
-   performed along the first non-zero dimension
    M = cummax(A,dim)
-   The operation is performed along the dimension specified by dim
    M = cummax(_,direction)
-   direction specifies as the direction of operation
-   
    </synopsis>
 </refsynopsisdiv>
 
 <refsection>
    <title>Parameters</title>
    <variablelist>
+
+   <varlistentry><term>A:</term>
+      <listitem><para> positive integer value<para></para>For complex elements, cummax compares the magnitude of elements. If the magnitude are same, phase angles are compared.</para></listitem></varlistentry>
+   <varlistentry><term>dim:</term>
+      <listitem><para> Dimension to operate along<para></para>If no dimension is specified, then the default value is the first array dimension whose value is greater than 1 </para></listitem></varlistentry>
+   <varlistentry><term>direction:</term>
+      <listitem><para>Direction of cumulation<para></para>If the direction is forward, cummax works from 1 to end of the active dimension. Otherwise, it works in the opposite sense</para></listitem></varlistentry>
+
    </variablelist>
 </refsection>
 
+<refsection>
+   <title>Description</title>
+   <para>
+The function returns the cumulative maximum elements of the input vector/array.
+
+
+</para>
+</refsection>
+
 <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
-1) Cumulative maximum values in a vector
+Cumulative maximum values in a vector
 v = [8 9 1 10 6 1 3 6 10 10]
 M = cummax(v)
 
-Expected output: [8 8 1 1 1 1 1 1 1 1]
+//Expected output: [8 9 9 10 10 10 10 10 10 10]
 
    ]]></programlisting>
 </refsection>
@@ -62,9 +72,5 @@ Expected output: [8 8 1 1 1 1 1 1 1 1]
    </simplelist>
 </refsection>
 
-<refsection>
-   <title>See also</title>
-   <simplelist type="inline">
-   </simplelist>
-</refsection>
+
 </refentry>
-- 
cgit