Mercurial > pytave

annotate @pyobject/dummy.m @ 428:3af3665348a1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Also update doctests in compiled functions * pycall.cc, pyeval.cc, pyexec.cc: Update doctests. * @pyobject/dummy.m, @pyobject/cell.m: Use FIXME and https in comments.
author Mike Miller <mtmiller@octave.org>
date Thu, 22 Feb 2018 15:55:15 -0800
parents 750a86973625
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
1 ## Copyright (C) 2016 Colin B. Macdonald
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
2 ##
246
4acc64f89d67 maint: fix copyright header comment blocks
Mike Miller <mtmiller@octave.org>
parents: 245
diff changeset
3 ## This file is part of Pytave
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
4 ##
246
4acc64f89d67 maint: fix copyright header comment blocks
Mike Miller <mtmiller@octave.org>
parents: 245
diff changeset
5 ## Pytave is free software; you can redistribute it and/or modify
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
6 ## it under the terms of the GNU General Public License as published
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
7 ## by the Free Software Foundation; either version 3 of the License,
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
8 ## or (at your option) any later version.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
9 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
10 ## This software is distributed in the hope that it will be useful,
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
11 ## but WITHOUT ANY WARRANTY; without even the implied warranty
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
12 ## of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
13 ## the GNU General Public License for more details.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
14 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
15 ## You should have received a copy of the GNU General Public
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
16 ## License along with this software; see the file COPYING.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
17 ## If not, see <http://www.gnu.org/licenses/>.
209
57807b5fa7bf Change name of pyobj to pyobject
genuinelucifer
parents:
diff changeset
18
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
19 ## -*- texinfo -*-
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
20 ## @documentencoding UTF-8
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
21 ## @defmethod @@pyobject dummy (@var{x})
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
22 ## Does nothing, stores doctests and other misc docs for now.
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
23 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
24 ##
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
25 ## Some simple Python objects are converted to equivalent Octave values:
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
26 ## @example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
27 ## @group
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
28 ## pyeval ("6.0")
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
29 ## @result{} ans = 6
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
30 ## @end group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
31 ## @end example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
32 ##
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
33 ## To ensure the return value is a @@pyobject, it can be cast:
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
34 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
35 ## @group
282
4c4747646e12 Make pyobject callable by users (to convert input)
Colin Macdonald <cbm@m.fsf.org>
parents: 254
diff changeset
36 ## g = pyobject (int32 (6))
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
37 ## @result{} g = [Python object of type int]
282
4c4747646e12 Make pyobject callable by users (to convert input)
Colin Macdonald <cbm@m.fsf.org>
parents: 254
diff changeset
38 ##
4c4747646e12 Make pyobject callable by users (to convert input)
Colin Macdonald <cbm@m.fsf.org>
parents: 254
diff changeset
39 ## 6
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
40 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
41 ## sort (methods (g))
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
42 ## @result{} ans =
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
43 ## @{
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
44 ## [1,1] = bit_length
308
72ecb31b163a Fix some pyobject doctests
Abhinav Tripathi <genuinelucifer@gmail.com>
parents: 282
diff changeset
45 ## ...
254
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
46 ## @}
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
47 ##
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
48 ## sort (fieldnames (g))
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
49 ## @result{} ans =
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
50 ## @{
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
51 ## [1,1] = denominator
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
52 ## [2,1] = imag
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
53 ## [3,1] = numerator
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
54 ## [4,1] = real
a3660e7f8dc9 Make methods output shape consistent with fieldnames
Colin Macdonald <cbm@m.fsf.org>
parents: 246
diff changeset
55 ## @}
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
56 ##
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
57 ## double (g.numerator)
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
58 ## @result{} ans = 6
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
59 ## double (g.denominator)
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
60 ## @result{} ans = 1
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
61 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
62 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
63 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
64 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
65 ## You can delete an object in Python and it will persist:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
66 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
67 ## @group
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
68 ## pyexec ("d = dict(two=2)")
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
69 ## x = pyeval ("d")
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
70 ## @result{} x = [Python object of type dict]
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
71 ## @{'two': 2@}
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
72 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
73 ## # oops, overwrote d in Python:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
74 ## pyexec ("d = 42")
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
75 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
76 ## # but have no fear, we still have a reference to it:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
77 ## x
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
78 ## @result{} x = [Python object of type dict]
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
79 ## @{'two': 2@}
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
80 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
81 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
82 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
83 ## We can accesss ``callables'' (methods) of objects:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
84 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
85 ## @group
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
86 ## double (x.pop ("two"))
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
87 ## @result{} ans = 2
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
88 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
89 ## @end example
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
90 ## And note this has changed the Python dict @code{x}:
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
91 ## @example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
92 ## @group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
93 ## x
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
94 ## @result{} x = [Python object of type dict]
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
95 ## @{@}
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
96 ## @end group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
97 ## @end example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
98 ##
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
99 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
100 ## @code{pyeval} returns a @@pyobject for things it cannot convert to
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
101 ## Octave-native objects:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
102 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
103 ## @group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
104 ## pyexec ("import sys")
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
105 ## sysmodule = pyeval ("sys")
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
106 ## @result{} sysmodule = [Python object of type module]
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
107 ## <module 'sys' (built-in)>
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
108 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
109 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
110 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
111 ## After you have the object, you can access its properties:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
112 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
113 ## @group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
114 ## sysmodule.version
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
115 ## @result{} ans = ...
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
116 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
117 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
118 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
119 ##
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
120 ## A Python list is returned as a @@pyobject:
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
121 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
122 ## @group
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
123 ## L = pyeval ("[42.0, 'hello', sys]")
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
124 ## @result{} L = [Python object of type list]
327
15c20ab4b80a Do not automatically convert Python integer types to Octave (see issue #56)
Mike Miller <mtmiller@octave.org>
parents: 313
diff changeset
125 ## [42.0, 'hello', <module 'sys' (built-in)>]
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
126 ## @end group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
127 ## @end example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
128 ##
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
129 ## Elements of the list can be accessed directly
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
130 ## @example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
131 ## @group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
132 ## L@{1@}
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
133 ## @result{} ans = 42
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
134 ## @end group
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
135 ## @end example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
136 ## or if needed, the list can be converted to a cell array:
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
137 ## @example
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
138 ## @group
428
3af3665348a1 Also update doctests in compiled functions
Mike Miller <mtmiller@octave.org>
parents: 427
diff changeset
139 ## @c FIXME: display of cell array in flux: https://savannah.gnu.org/bugs/?50756
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
140 ## @c doctest: +XFAIL
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
141 ## cell (L)
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
142 ## @result{} ans =
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
143 ## @{
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
144 ## [1,1] = 42
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
145 ## [1,2] = [Python object of type str]
365
087e7bc3697f Do not automatically convert Python strings to Octave strings (fixes issue #65)
Mike Miller <mtmiller@octave.org>
parents: 327
diff changeset
146 ## hello
427
750a86973625 Update doctests for display changes
Colin Macdonald <cbm@m.fsf.org>
parents: 365
diff changeset
147 ## [1,3] = [Python object of type module]
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
148 ## <module 'sys' (built-in)>
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
149 ## @}
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
150 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
151 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
152 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
153 ## A @@pyobject can be passed back to Python. This does not make
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
154 ## a copy but rather a reference to the original object.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
155 ## For example:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
156 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
157 ## @group
365
087e7bc3697f Do not automatically convert Python strings to Octave strings (fixes issue #65)
Mike Miller <mtmiller@octave.org>
parents: 327
diff changeset
158 ## char (pycall ("repr", sysmodule))
313
01ff03fef237 Update docs for recent changes
Colin Macdonald <cbm@m.fsf.org>
parents: 308
diff changeset
159 ## @result{} <module 'sys' (built-in)>
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
160 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
161 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
162 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
163 ## @seealso{pyobject}
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 217
diff changeset
164 ## @end defmethod
209
57807b5fa7bf Change name of pyobj to pyobject
genuinelucifer
parents:
diff changeset
165
57807b5fa7bf Change name of pyobj to pyobject
genuinelucifer
parents:
diff changeset
166 function dummy (x)
245
72a2f508f2d8 maint: Use Octave keywords for ending code blocks
Mike Miller <mtmiller@octave.org>
parents: 227
diff changeset
167 endfunction