Mercurial > octave-nkf
changeset 15776:169a47c5e254
recycle.m: Fix docstring.
* recycle.m: Fix docstring.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 12 Dec 2012 16:01:52 -0800 |
parents | a1d1386daeed |
children | b8bcb2c7f3e8 |
files | scripts/miscellaneous/recycle.m |
diffstat | 1 files changed, 5 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/miscellaneous/recycle.m Wed Dec 12 18:07:55 2012 -0500 +++ b/scripts/miscellaneous/recycle.m Wed Dec 12 16:01:52 2012 -0800 @@ -17,13 +17,13 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{current_state}} recycle () -## @deftypefnx {Function File} {@var{old_state}} recycle (@var{new_state}) +## @deftypefn {Function File} {@var{current_state} =} recycle () +## @deftypefnx {Function File} {@var{old_state} =} recycle (@var{new_state}) ## Query or set the preference for recycling deleted files. ## -## Recycling files instead of permanently deleting them is currently not -## implemented in Octave. To help avoid accidental data loss it -## is an error to attempt enable file recycling. +## Recycling files, instead of permanently deleting them, is not currently +## implemented in Octave. To help avoid accidental data loss an error +## will be raised if an attempt is made to enable file recycling. ## @seealso{delete} ## @end deftypefn