changeset 201:b3c23054a9c2

Add doctest for variable persistence @pyobj/dummy.m: new file for some docs
author Colin Macdonald <cbm@m.fsf.org>
date Thu, 19 May 2016 17:08:03 -0700
parents 65fead19215f
children 3fa99babc7b5
files @pyobj/dummy.m
diffstat 1 files changed, 50 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/@pyobj/dummy.m	Thu May 19 17:08:03 2016 -0700
@@ -0,0 +1,50 @@
+%% Copyright (C) 2016 Colin B. Macdonald
+%%
+%% This file is part of PyTave.
+%%
+%% OctSymPy 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.
+%%
+%% This software 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 this software; see the file COPYING.
+%% If not, see <http://www.gnu.org/licenses/>.
+
+%% -*- texinfo -*-
+%% @documentencoding UTF-8
+%% @defmethod @@pyobj dummy (@var{x})
+%% Does nothing, stores doctests for now.
+%%
+%%
+%% You can delete an object in Python and it will persist:
+%% @example
+%% @group
+%% pyexec('d = dict(one=1, two=2)')
+%% x = pyobj('d')
+%%   @result{} x =
+%%       [PyObject id ...]
+%%       @{'two': 2, 'one': 1@}
+%%
+%% % oops, overwrote d in Python:
+%% pyexec('d = 42')
+%%
+%% % but have no fear, we still have a reference to it:
+%% x
+%%   @result{} x =
+%%       [PyObject id ...]
+%%       @{'two': 2, 'one': 1@}
+%% @end group
+%% @end example
+%%
+%% @seealso{pyobj}
+%% @end defmethod
+
+function dummy (x)
+
+end