[Octave-bug-tracker] [bug #49526] "help slash": an easy way to discover what backslash does

[Rik]

Update of bug #49526 (project octave):

                Severity:              3 - Normal => 1 - Wish               
                Priority:              5 - Normal => 3 - Low                
                  Status:                    None => Confirmed              
                 Summary: "help slash": an easy way to discouver what
backslash does => "help slash": an easy way to discover what backslash does

    _______________________________________________________

Follow-up Comment #1:

This is pretty easy to add.  What is usually done is an m-file is created that
has the name you want to find the help under (slash.m) and the file contains
just a copyright, the help text, and a single BIST test to mark it as covered.
 The m-file is placed in scripts/help.  For an example, look at ans.m which
gives help about the built-in variable ans.  The entire m-file is


## Copyright (C) 2006-2016 John W. Eaton
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @defvr {Automatic Variable} ans
## The most recently computed result that was not explicitly assigned to a
## variable.
##
## For example, after the expression
##
## @example
## 3^2 + 4^2
## @end example
##
## @noindent
## is evaluated, the value returned by @code{ans} is 25.
## @end defvr


## Mark file as being tested.  No real test needed for a documentation .m
file
%!assert (1)



If you can prepare such a file for the various slash operators then I will
check it in.

The documentation that you found is in doc/interpreter/expr.txi.  You could
grab the part about the left division operator to begin populating the slash.m
file.

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?49526>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/