# HG changeset patch
# User Rik <rik@octave.org>
# Date 1649096546 25200
# Node ID 1a3cc2811090294afc836d429ec98961ca5b0405
# Parent  79b3c0b5c265995482db76ec35f02d3bc561d40d
doc: Update documentation for __sort_rows_idx__.

* data.cc (F__sort_rows_idx__): Remove comment about function being unused.
Add FIXME note about lack of support for sparse matrices.  Update docstring
to reference input/output variables and sortrows.m.

diff -r 79b3c0b5c265 -r 1a3cc2811090 libinterp/corefcn/data.cc
--- a/libinterp/corefcn/data.cc	Mon Apr 04 11:16:29 2022 -0700
+++ b/libinterp/corefcn/data.cc	Mon Apr 04 11:22:26 2022 -0700
@@ -7249,13 +7249,12 @@
 // specified by @var{mode}, which can either be 'ascend' or 'descend'
 // and return the index vector corresponding to the sort order.
 //
-// This function does not yet support sparse matrices.
-
-// FIXME: Is this function used anymore?  12/14/2015
+// FIXME: This function does not yet support sparse matrices.
+
 DEFUN (__sort_rows_idx__, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {} __sort_rows_idx__ (@var{a}, @var{mode})
-Undocumented internal function.
+@deftypefn {} {@var{idx} =} __sort_rows_idx__ (@var{A}, @var{mode})
+Called internally from @file{sortrows.m}.
 @end deftypefn */)
 {
   int nargin = args.length ();