| | | |
Offset 191, 15 lines modified | Offset 191, 15 lines modified |
191 | <dd><dl·class="simple"> | 191 | <dd><dl·class="simple"> |
192 | <dt>Example·of·a·complete·dataset·with·all·possible·items.·Used·as·an·autodoc</dt><dd><p>example.</p> | 192 | <dt>Example·of·a·complete·dataset·with·all·possible·items.·Used·as·an·autodoc</dt><dd><p>example.</p> |
193 | </dd> | 193 | </dd> |
194 | </dl> | 194 | </dl> |
195 | <dl·class="py·attribute"> | 195 | <dl·class="py·attribute"> |
196 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.dir"> | 196 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.dir"> |
197 | <span·class="sig-name·descname"><span·class="pre">dir</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.dir"·title="Link·to·this·definition">¶</a></dt> | 197 | <span·class="sig-name·descname"><span·class="pre">dir</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.dir"·title="Link·to·this·definition">¶</a></dt> |
198 | <dd><p><strong>Directory</strong>.··Default:·‘/tmp/test_pxo8cz18’.</p> | 198 | <dd><p><strong>Directory</strong>.··Default:·‘/tmp/test_3cazihal’.</p> |
199 | <dl·class="field-list·simple"> | 199 | <dl·class="field-list·simple"> |
200 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> | 200 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> |
201 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.DirectoryItem"·title="guidata.dataset.dataitems.DirectoryItem">guidata.dataset.dataitems.DirectoryItem</a></p> | 201 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.DirectoryItem"·title="guidata.dataset.dataitems.DirectoryItem">guidata.dataset.dataitems.DirectoryItem</a></p> |
202 | </dd> | 202 | </dd> |
203 | </dl> | 203 | </dl> |
204 | </dd></dl> | 204 | </dd></dl> |
| |
Offset 246, 37 lines modified | Offset 246, 37 lines modified |
246 | </dd> | 246 | </dd> |
247 | </dl> | 247 | </dl> |
248 | </dd></dl> | 248 | </dd></dl> |
| |
249 | <dl·class="py·attribute"> | 249 | <dl·class="py·attribute"> |
250 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fname"> | 250 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fname"> |
251 | <span·class="sig-name·descname"><span·class="pre">fname</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fname"·title="Link·to·this·definition">¶</a></dt> | 251 | <span·class="sig-name·descname"><span·class="pre">fname</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fname"·title="Link·to·this·definition">¶</a></dt> |
252 | <dd><p>Open·file.··Supported·file·types:·*.csv,·*.eta.·Default:·‘/tmp/test_pxo8cz18/tmps2uvgs05.csv’.</p> | 252 | <dd><p>Open·file.··Supported·file·types:·*.csv,·*.eta.·Default:·‘/tmp/test_3cazihal/tmpkop8t8fs.csv’.</p> |
253 | <dl·class="field-list·simple"> | 253 | <dl·class="field-list·simple"> |
254 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> | 254 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> |
255 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FileOpenItem"·title="guidata.dataset.dataitems.FileOpenItem">guidata.dataset.dataitems.FileOpenItem</a></p> | 255 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FileOpenItem"·title="guidata.dataset.dataitems.FileOpenItem">guidata.dataset.dataitems.FileOpenItem</a></p> |
256 | </dd> | 256 | </dd> |
257 | </dl> | 257 | </dl> |
258 | </dd></dl> | 258 | </dd></dl> |
| |
259 | <dl·class="py·attribute"> | 259 | <dl·class="py·attribute"> |
260 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fnames"> | 260 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fnames"> |
261 | <span·class="sig-name·descname"><span·class="pre">fnames</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fnames"·title="Link·to·this·definition">¶</a></dt> | 261 | <span·class="sig-name·descname"><span·class="pre">fnames</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fnames"·title="Link·to·this·definition">¶</a></dt> |
262 | <dd><p>Open·files.··Supported·file·types:·*.csv.·Default:·‘/tmp/test_pxo8cz18/tmps2uvgs05.csv’.</p> | 262 | <dd><p>Open·files.··Supported·file·types:·*.csv.·Default:·‘/tmp/test_3cazihal/tmpkop8t8fs.csv’.</p> |
263 | <dl·class="field-list·simple"> | 263 | <dl·class="field-list·simple"> |
264 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> | 264 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> |
265 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FilesOpenItem"·title="guidata.dataset.dataitems.FilesOpenItem">guidata.dataset.dataitems.FilesOpenItem</a></p> | 265 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FilesOpenItem"·title="guidata.dataset.dataitems.FilesOpenItem">guidata.dataset.dataitems.FilesOpenItem</a></p> |
266 | </dd> | 266 | </dd> |
267 | </dl> | 267 | </dl> |
268 | </dd></dl> | 268 | </dd></dl> |
| |
269 | <dl·class="py·attribute"> | 269 | <dl·class="py·attribute"> |
270 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fname_s"> | 270 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.fname_s"> |
271 | <span·class="sig-name·descname"><span·class="pre">fname_s</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fname_s"·title="Link·to·this·definition">¶</a></dt> | 271 | <span·class="sig-name·descname"><span·class="pre">fname_s</span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.fname_s"·title="Link·to·this·definition">¶</a></dt> |
272 | <dd><p>Save·file.··Supported·file·types:·*.eta.·Default:·‘/tmp/test_pxo8cz18/tmpwlvl_spv.eta’.</p> | 272 | <dd><p>Save·file.··Supported·file·types:·*.eta.·Default:·‘/tmp/test_3cazihal/tmp86dpe12z.eta’.</p> |
273 | <dl·class="field-list·simple"> | 273 | <dl·class="field-list·simple"> |
274 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> | 274 | <dt·class="field-odd">Type<span·class="colon">:</span></dt> |
275 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FileSaveItem"·title="guidata.dataset.dataitems.FileSaveItem">guidata.dataset.dataitems.FileSaveItem</a></p> | 275 | <dd·class="field-odd"><p><a·class="reference·internal"·href="../reference/dataset/dataitems.html#guidata.dataset.FileSaveItem"·title="guidata.dataset.dataitems.FileSaveItem">guidata.dataset.dataitems.FileSaveItem</a></p> |
276 | </dd> | 276 | </dd> |
277 | </dl> | 277 | </dl> |
278 | </dd></dl> | 278 | </dd></dl> |
| |
Offset 448, 22 lines modified | Offset 448, 22 lines modified |
448 | <dl·class="py·method"> | 448 | <dl·class="py·method"> |
449 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.create"> | 449 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam1.create"> |
450 | <em·class="property"><span·class="pre">classmethod</span><span·class="w">·</span></em><span·class="sig-name·descname"><span·class="pre">create</span></span><span·class="sig-paren">(</span><em·class="sig-param"><span·class="n"><span·class="pre">dir</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">a</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><span·class="pre">float</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">b</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">c</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">type</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fname</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fnames</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#list"·title="(in·Python·v3.12)"><span·class="pre">list</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fname_s</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">string</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">text</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">float_slider</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><span·class="pre">float</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">integer</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">dtime</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.datetime"·title="(in·Python·v3.12)"><span·class="pre">datetime.datetime</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">date</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.date"·title="(in·Python·v3.12)"><span·class="pre">datetime.date</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">bool1</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">bool2</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">color</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">choice</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice2</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">floatarray</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><span·class="pre">numpy.ndarray</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice3</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice1</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">dictionary</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#dict"·title="(in·Python·v3.12)"><span·class="pre">dict</span></a></span></em><span·class="sig-paren">)</span>·<span·class="sig-return"><span·class="sig-return-icon">→</span>·<span·class="sig-return-typehint"><a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><span·class="pre">autodoc_example.AutodocExampleParam1</span></a></span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.create"·title="Link·to·this·definition">¶</a></dt> | 450 | <em·class="property"><span·class="pre">classmethod</span><span·class="w">·</span></em><span·class="sig-name·descname"><span·class="pre">create</span></span><span·class="sig-paren">(</span><em·class="sig-param"><span·class="n"><span·class="pre">dir</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">a</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><span·class="pre">float</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">b</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">c</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">type</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fname</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fnames</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#list"·title="(in·Python·v3.12)"><span·class="pre">list</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">fname_s</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">string</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">text</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">float_slider</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><span·class="pre">float</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">integer</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">dtime</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.datetime"·title="(in·Python·v3.12)"><span·class="pre">datetime.datetime</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">date</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.date"·title="(in·Python·v3.12)"><span·class="pre">datetime.date</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">bool1</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">bool2</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">color</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">choice</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice2</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">floatarray</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><span·class="pre">numpy.ndarray</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice3</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">mchoice1</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><span·class="pre">int</span></a></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">dictionary</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#dict"·title="(in·Python·v3.12)"><span·class="pre">dict</span></a></span></em><span·class="sig-paren">)</span>·<span·class="sig-return"><span·class="sig-return-icon">→</span>·<span·class="sig-return-typehint"><a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><span·class="pre">autodoc_example.AutodocExampleParam1</span></a></span></span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam1.create"·title="Link·to·this·definition">¶</a></dt> |
451 | <dd><p>Returns·a·new·instance·of·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·with·the·fields·set·to·the·given·values.</p> | 451 | <dd><p>Returns·a·new·instance·of·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·with·the·fields·set·to·the·given·values.</p> |
452 | <dl·class="field-list·simple"> | 452 | <dl·class="field-list·simple"> |
453 | <dt·class="field-odd">Parameters<span·class="colon">:</span></dt> | 453 | <dt·class="field-odd">Parameters<span·class="colon">:</span></dt> |
454 | <dd·class="field-odd"><ul·class="simple"> | 454 | <dd·class="field-odd"><ul·class="simple"> |
455 | <li><p><strong>dir</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·<strong>Directory</strong>.··Default:·‘/tmp/test_pxo8cz18’.</p></li> | 455 | <li><p><strong>dir</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·<strong>Directory</strong>.··Default:·‘/tmp/test_3cazihal’.</p></li> |
456 | <li><p><strong>a</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><em>float</em></a>)·–·Parameter·#1.··Default:·2.3.</p></li> | 456 | <li><p><strong>a</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><em>float</em></a>)·–·Parameter·#1.··Default:·2.3.</p></li> |
457 | <li><p><strong>b</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Parameter·#2.··Integer·between·0·and·10.·Default:·5.</p></li> | 457 | <li><p><strong>b</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Parameter·#2.··Integer·between·0·and·10.·Default:·5.</p></li> |
458 | <li><p><strong>c</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Parameter·#3.··Default:·‘default·value’.</p></li> | 458 | <li><p><strong>c</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Parameter·#3.··Default:·‘default·value’.</p></li> |
459 | <li><p><strong>type</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Processing·algorithm.··Single·choice·from:·0,·1,·2.·Default:·0.</p></li> | 459 | <li><p><strong>type</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Processing·algorithm.··Single·choice·from:·0,·1,·2.·Default:·0.</p></li> |
460 | <li><p><strong>fname</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Open·file.··Supported·file·types:·*.csv,·*.eta.·Default:·‘/tmp/test_pxo8cz18/tmps2uvgs05.csv’.</p></li> | 460 | <li><p><strong>fname</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Open·file.··Supported·file·types:·*.csv,·*.eta.·Default:·‘/tmp/test_3cazihal/tmpkop8t8fs.csv’.</p></li> |
461 | <li><p><strong>fnames</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#list"·title="(in·Python·v3.12)"><em>list</em></a>)·–·Open·files.··Supported·file·types:·*.csv.·Default:·‘/tmp/test_pxo8cz18/tmps2uvgs05.csv’.</p></li> | 461 | <li><p><strong>fnames</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#list"·title="(in·Python·v3.12)"><em>list</em></a>)·–·Open·files.··Supported·file·types:·*.csv.·Default:·‘/tmp/test_3cazihal/tmpkop8t8fs.csv’.</p></li> |
462 | <li><p><strong>fname_s</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Save·file.··Supported·file·types:·*.eta.·Default:·‘/tmp/test_pxo8cz18/tmpwlvl_spv.eta’.</p></li> | 462 | <li><p><strong>fname_s</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Save·file.··Supported·file·types:·*.eta.·Default:·‘/tmp/test_3cazihal/tmp86dpe12z.eta’.</p></li> |
463 | <li><p><strong>string</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Default:·None.</p></li> | 463 | <li><p><strong>string</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Default:·None.</p></li> |
464 | <li><p><strong>text</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Default:·None.</p></li> | 464 | <li><p><strong>text</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><em>str</em></a>)·–·Default:·None.</p></li> |
465 | <li><p><strong>float_slider</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><em>float</em></a>)·–·Float·(with·slider).··Float·between·0·and·1.·Default:·0.5.</p></li> | 465 | <li><p><strong>float_slider</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#float"·title="(in·Python·v3.12)"><em>float</em></a>)·–·Float·(with·slider).··Float·between·0·and·1.·Default:·0.5.</p></li> |
466 | <li><p><strong>integer</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Integer·between·3·and·16.·Default:·5.</p></li> | 466 | <li><p><strong>integer</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#int"·title="(in·Python·v3.12)"><em>int</em></a>)·–·Integer·between·3·and·16.·Default:·5.</p></li> |
467 | <li><p><strong>dtime</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.datetime"·title="(in·Python·v3.12)"><em>datetime.datetime</em></a>)·–·Date/time.··Default:·datetime.datetime(2010,·10,·10,·0,·0).</p></li> | 467 | <li><p><strong>dtime</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.datetime"·title="(in·Python·v3.12)"><em>datetime.datetime</em></a>)·–·Date/time.··Default:·datetime.datetime(2010,·10,·10,·0,·0).</p></li> |
468 | <li><p><strong>date</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.date"·title="(in·Python·v3.12)"><em>datetime.date</em></a>)·–·Default:·datetime.date(2010,·10,·10).</p></li> | 468 | <li><p><strong>date</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/datetime.html#datetime.date"·title="(in·Python·v3.12)"><em>datetime.date</em></a>)·–·Default:·datetime.date(2010,·10,·10).</p></li> |
469 | <li><p><strong>bool1</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><em>bool</em></a>)·–·Default:·None.</p></li> | 469 | <li><p><strong>bool1</strong>·(<a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><em>bool</em></a>)·–·Default:·None.</p></li> |
Offset 482, 27 lines modified | Offset 482, 27 lines modified |
482 | </dd> | 482 | </dd> |
483 | </dl> | 483 | </dl> |
484 | </dd></dl> | 484 | </dd></dl> |
| |
485 | <div·class="admonition·note"> | 485 | <div·class="admonition·note"> |
486 | <p·class="admonition-title">Note</p> | 486 | <p·class="admonition-title">Note</p> |
487 | <p>To·instanciate·a·new·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·dataset,·you·can·use·the·classmethod·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1.create"·title="autodoc_example.AutodocExampleParam1.create"><code·class="xref·py·py-meth·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1.create()</span></code></a>·like·this:</p> | 487 | <p>To·instanciate·a·new·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·dataset,·you·can·use·the·classmethod·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1.create"·title="autodoc_example.AutodocExampleParam1.create"><code·class="xref·py·py-meth·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1.create()</span></code></a>·like·this:</p> |
488 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">AutodocExampleParam1</span><span·class="o">.</span><span·class="n">create</span><span·class="p">(</span><span·class="nb">dir</span><span·class="o">=</span><span·class="s1">'/tmp/test_pxo8cz18'</span><span·class="p">,</span>·<span·class="n">a</span><span·class="o">=</span><span·class="mf">2.3</span><span·class="p">,</span>·<span·class="n">b</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="[·...·truncated·by·diffoscope;·len:·606,·SHA:·0b3e552c4c17e7ba149375a1c3d0bdf1859debcd9e6c06c63c7a8b809ea2829d·...·].eta'</span><span·class="p">,</span>·<span·class="n">string</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">text</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">float_slider</span><span·class="o">=</span><span·class="mf">0.5</span><span·class="p">,</span>·<span·class="n">integer</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="n">dtime</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">),</span>·<span·class="n">date</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">),</span>·<span·class="n">bool1</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">bool2</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">color</span><span·class="o">=</span><span·class="s1">'red'</span><span·class="p">,</span>·<span·class="n">choice</span><span·class="o">=</span><span·class="s1">'16'</span><span·class="p">,</span>·<span·class="n">mchoice2</span><span·class="o">=</span><span·class="s1">'rect'</span><span·class="p">,</span>·<span·class="n">floatarray</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">mchoice3</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">mchoice1</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">dictionary</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">)</span> | 488 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">AutodocExampleParam1</span><span·class="o">.</span><span·class="n">create</span><span·class="p">(</span><span·class="nb">dir</span><span·class="o">=</span><span·class="s1">'/tmp/test_3cazihal'</span><span·class="p">,</span>·<span·class="n">a</span><span·class="o">=</span><span·class="mf">2.3</span><span·class="p">,</span>·<span·class="n">b</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="[·...·truncated·by·diffoscope;·len:·606,·SHA:·87f661a8957e8e1a2f804cf7a276fd171a82731dcd7a4ec5310d978bdf0f6868·...·].eta'</span><span·class="p">,</span>·<span·class="n">string</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">text</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">float_slider</span><span·class="o">=</span><span·class="mf">0.5</span><span·class="p">,</span>·<span·class="n">integer</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="n">dtime</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">),</span>·<span·class="n">date</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">),</span>·<span·class="n">bool1</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">bool2</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">color</span><span·class="o">=</span><span·class="s1">'red'</span><span·class="p">,</span>·<span·class="n">choice</span><span·class="o">=</span><span·class="s1">'16'</span><span·class="p">,</span>·<span·class="n">mchoice2</span><span·class="o">=</span><span·class="s1">'rect'</span><span·class="p">,</span>·<span·class="n">floatarray</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">mchoice3</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">mchoice1</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">dictionary</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">)</span> |
489 | </pre></div> | 489 | </pre></div> |
490 | </div> | 490 | </div> |
491 | <p>You·can·also·first·instanciate·a·default·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·and·then·set·the·fields·like·this:</p> | 491 | <p>You·can·also·first·instanciate·a·default·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam1"·title="autodoc_example.AutodocExampleParam1"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam1</span></code></a>·and·then·set·the·fields·like·this:</p> |
492 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">param</span>·<span·class="o">=</span>·<span·class="n">AutodocExampleParam1</span><span·class="p">()</span> | 492 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">param</span>·<span·class="o">=</span>·<span·class="n">AutodocExampleParam1</span><span·class="p">()</span> |
493 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dir</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_pxo8cz18'</span> | 493 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dir</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_3cazihal'</span> |
494 | <span·class="n">param</span><span·class="o">.</span><span·class="n">a</span>·<span·class="o">=</span>·<span·class="mf">2.3</span> | 494 | <span·class="n">param</span><span·class="o">.</span><span·class="n">a</span>·<span·class="o">=</span>·<span·class="mf">2.3</span> |
495 | <span·class="n">param</span><span·class="o">.</span><span·class="n">b</span>·<span·class="o">=</span>·<span·class="mi">5</span> | 495 | <span·class="n">param</span><span·class="o">.</span><span·class="n">b</span>·<span·class="o">=</span>·<span·class="mi">5</span> |
496 | <span·class="n">param</span><span·class="o">.</span><span·class="n">c</span>·<span·class="o">=</span>·<span·class="s1">'default·value'</span> | 496 | <span·class="n">param</span><span·class="o">.</span><span·class="n">c</span>·<span·class="o">=</span>·<span·class="s1">'default·value'</span> |
497 | <span·class="n">param</span><span·class="o">.</span><span·class="n">type</span>·<span·class="o">=</span>·<span·class="mi">0</span> | 497 | <span·class="n">param</span><span·class="o">.</span><span·class="n">type</span>·<span·class="o">=</span>·<span·class="mi">0</span> |
498 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fname</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_pxo8cz18/tmps2uvgs05.csv'</span> | 498 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fname</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_3cazihal/tmpkop8t8fs.csv'</span> |
499 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fnames</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_pxo8cz18/tmps2uvgs05.csv'</span> | 499 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fnames</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_3cazihal/tmpkop8t8fs.csv'</span> |
500 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fname_s</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_pxo8cz18/tmpwlvl_spv.eta'</span> | 500 | <span·class="n">param</span><span·class="o">.</span><span·class="n">fname_s</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_3cazihal/tmp86dpe12z.eta'</span> |
501 | <span·class="n">param</span><span·class="o">.</span><span·class="n">string</span>·<span·class="o">=</span>·<span·class="kc">None</span> | 501 | <span·class="n">param</span><span·class="o">.</span><span·class="n">string</span>·<span·class="o">=</span>·<span·class="kc">None</span> |
502 | <span·class="n">param</span><span·class="o">.</span><span·class="n">text</span>·<span·class="o">=</span>·<span·class="kc">None</span> | 502 | <span·class="n">param</span><span·class="o">.</span><span·class="n">text</span>·<span·class="o">=</span>·<span·class="kc">None</span> |
503 | <span·class="n">param</span><span·class="o">.</span><span·class="n">float_slider</span>·<span·class="o">=</span>·<span·class="mf">0.5</span> | 503 | <span·class="n">param</span><span·class="o">.</span><span·class="n">float_slider</span>·<span·class="o">=</span>·<span·class="mf">0.5</span> |
504 | <span·class="n">param</span><span·class="o">.</span><span·class="n">integer</span>·<span·class="o">=</span>·<span·class="mi">5</span> | 504 | <span·class="n">param</span><span·class="o">.</span><span·class="n">integer</span>·<span·class="o">=</span>·<span·class="mi">5</span> |
505 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dtime</span>·<span·class="o">=</span>·<span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">)</span> | 505 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dtime</span>·<span·class="o">=</span>·<span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">)</span> |
506 | <span·class="n">param</span><span·class="o">.</span><span·class="n">date</span>·<span·class="o">=</span>·<span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">)</span> | 506 | <span·class="n">param</span><span·class="o">.</span><span·class="n">date</span>·<span·class="o">=</span>·<span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">)</span> |
507 | <span·class="n">param</span><span·class="o">.</span><span·class="n">bool1</span>·<span·class="o">=</span>·<span·class="kc">None</span> | 507 | <span·class="n">param</span><span·class="o">.</span><span·class="n">bool1</span>·<span·class="o">=</span>·<span·class="kc">None</span> |
Offset 547, 20 lines modified | Offset 547, 20 lines modified |
547 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam2"> | 547 | <dt·class="sig·sig-object·py"·id="autodoc_example.AutodocExampleParam2"> |
548 | <em·class="property"><span·class="pre">class</span><span·class="w">·</span></em><span·class="sig-prename·descclassname"><span·class="pre">autodoc_example.</span></span><span·class="sig-name·descname"><span·class="pre">AutodocExampleParam2</span></span><span·class="sig-paren">(</span><em·class="sig-param"><span·class="n"><span·class="pre">title</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/constants.html#None"·title="(in·Python·v3.12)"><span·class="pre">None</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">None</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">comment</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/constants.html#None"·title="(in·Python·v3.12)"><span·class="pre">None</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">None</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">icon</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">''</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">readonly</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">False</span></span></em><span·class="sig-paren">)</span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam2"·title="Link·to·this·definition">¶</a></dt> | 548 | <em·class="property"><span·class="pre">class</span><span·class="w">·</span></em><span·class="sig-prename·descclassname"><span·class="pre">autodoc_example.</span></span><span·class="sig-name·descname"><span·class="pre">AutodocExampleParam2</span></span><span·class="sig-paren">(</span><em·class="sig-param"><span·class="n"><span·class="pre">title</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/constants.html#None"·title="(in·Python·v3.12)"><span·class="pre">None</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">None</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">comment</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a><span·class="w">·</span><span·class="p"><span·class="pre">|</span></span><span·class="w">·</span><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/constants.html#None"·title="(in·Python·v3.12)"><span·class="pre">None</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">None</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">icon</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/stdtypes.html#str"·title="(in·Python·v3.12)"><span·class="pre">str</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">''</span></span></em>,·<em·class="sig-param"><span·class="n"><span·class="pre">readonly</span></span><span·class="p"><span·class="pre">:</span></span><span·class="w">·</span><span·class="n"><a·class="reference·external"·href="/usr/share/doc/python3-doc/html/library/functions.html#bool"·title="(in·Python·v3.12)"><span·class="pre">bool</span></a></span><span·class="w">·</span><span·class="o"><span·class="pre">=</span></span><span·class="w">·</span><span·class="default_value"><span·class="pre">False</span></span></em><span·class="sig-paren">)</span><a·class="headerlink"·href="#autodoc_example.AutodocExampleParam2"·title="Link·to·this·definition">¶</a></dt> |
549 | <dd><p>Example·of·a·complete·dataset·with·all·possible·items.·Used·as·an·autodoc | 549 | <dd><p>Example·of·a·complete·dataset·with·all·possible·items.·Used·as·an·autodoc |
550 | example.</p> | 550 | example.</p> |
551 | <div·class="admonition·note"> | 551 | <div·class="admonition·note"> |
552 | <p·class="admonition-title">Note</p> | 552 | <p·class="admonition-title">Note</p> |
553 | <p>To·instanciate·a·new·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam2"·title="autodoc_example.AutodocExampleParam2"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2</span></code></a>·dataset,·you·can·use·the·classmethod·<code·class="xref·py·py-meth·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2.create()</span></code>·like·this:</p> | 553 | <p>To·instanciate·a·new·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam2"·title="autodoc_example.AutodocExampleParam2"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2</span></code></a>·dataset,·you·can·use·the·classmethod·<code·class="xref·py·py-meth·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2.create()</span></code>·like·this:</p> |
554 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">AutodocExampleParam2</span><span·class="o">.</span><span·class="n">create</span><span·class="p">(</span><span·class="nb">dir</span><span·class="o">=</span><span·class="s1">'/tmp/test_pxo8cz18'</span><span·class="p">,</span>·<span·class="n">a</span><span·class="o">=</span><span·class="mf">2.3</span><span·class="p">,</span>·<span·class="n">b</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="[·...·truncated·by·diffoscope;·len:·606,·SHA:·0b3e552c4c17e7ba149375a1c3d0bdf1859debcd9e6c06c63c7a8b809ea2829d·...·].eta'</span><span·class="p">,</span>·<span·class="n">string</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">text</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">float_slider</span><span·class="o">=</span><span·class="mf">0.5</span><span·class="p">,</span>·<span·class="n">integer</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="n">dtime</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">),</span>·<span·class="n">date</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">),</span>·<span·class="n">bool1</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">bool2</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">color</span><span·class="o">=</span><span·class="s1">'red'</span><span·class="p">,</span>·<span·class="n">choice</span><span·class="o">=</span><span·class="s1">'16'</span><span·class="p">,</span>·<span·class="n">mchoice2</span><span·class="o">=</span><span·class="s1">'rect'</span><span·class="p">,</span>·<span·class="n">floatarray</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">mchoice3</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">mchoice1</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">dictionary</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">)</span> | 554 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">AutodocExampleParam2</span><span·class="o">.</span><span·class="n">create</span><span·class="p">(</span><span·class="nb">dir</span><span·class="o">=</span><span·class="s1">'/tmp/test_3cazihal'</span><span·class="p">,</span>·<span·class="n">a</span><span·class="o">=</span><span·class="mf">2.3</span><span·class="p">,</span>·<span·class="n">b</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="[·...·truncated·by·diffoscope;·len:·606,·SHA:·87f661a8957e8e1a2f804cf7a276fd171a82731dcd7a4ec5310d978bdf0f6868·...·].eta'</span><span·class="p">,</span>·<span·class="n">string</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">text</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">float_slider</span><span·class="o">=</span><span·class="mf">0.5</span><span·class="p">,</span>·<span·class="n">integer</span><span·class="o">=</span><span·class="mi">5</span><span·class="p">,</span>·<span·class="n">dtime</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">datetime</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">,</span>·<span·class="mi">0</span><span·class="p">),</span>·<span·class="n">date</span><span·class="o">=</span><span·class="n">datetime</span><span·class="o">.</span><span·class="n">date</span><span·class="p">(</span><span·class="mi">2010</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">,</span>·<span·class="mi">10</span><span·class="p">),</span>·<span·class="n">bool1</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">bool2</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">color</span><span·class="o">=</span><span·class="s1">'red'</span><span·class="p">,</span>·<span·class="n">choice</span><span·class="o">=</span><span·class="s1">'16'</span><span·class="p">,</span>·<span·class="n">mchoice2</span><span·class="o">=</span><span·class="s1">'rect'</span><span·class="p">,</span>·<span·class="n">floatarray</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">,</span>·<span·class="n">mchoice3</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">mchoice1</span><span·class="o">=</span><span·class="p">(),</span>·<span·class="n">dictionary</span><span·class="o">=</span><span·class="kc">None</span><span·class="p">)</span> |
555 | </pre></div> | 555 | </pre></div> |
556 | </div> | 556 | </div> |
557 | <p>You·can·also·first·instanciate·a·default·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam2"·title="autodoc_example.AutodocExampleParam2"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2</span></code></a>·and·then·set·the·fields·like·this:</p> | 557 | <p>You·can·also·first·instanciate·a·default·<a·class="reference·internal"·href="#autodoc_example.AutodocExampleParam2"·title="autodoc_example.AutodocExampleParam2"><code·class="xref·py·py-class·docutils·literal·notranslate"><span·class="pre">AutodocExampleParam2</span></code></a>·and·then·set·the·fields·like·this:</p> |
558 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">param</span>·<span·class="o">=</span>·<span·class="n">AutodocExampleParam2</span><span·class="p">()</span> | 558 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="n">param</span>·<span·class="o">=</span>·<span·class="n">AutodocExampleParam2</span><span·class="p">()</span> |
559 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dir</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_pxo8cz18'</span> | 559 | <span·class="n">param</span><span·class="o">.</span><span·class="n">dir</span>·<span·class="o">=</span>·<span·class="s1">'/tmp/test_3cazihal'</span> |
560 | <span·class="n">param</span><span·class="o">.</span><span·class="n">a</span>·<span·class="o">=</span>·<span·class="mf">2.3</span> | 560 | <span·class="n">param</span><span·class="o">.</span><span·class="n">a</span>·<span·class="o">=</span>·<span·class="mf">2.3</span> |
561 | <span·class="n">param</span><span·class="o">.</span><span·class="n">b</span>·<span·class="o">=</span>·<span·class="mi">5</span> | 561 | <span·class="n">param</span><span·class="o">.</span><span·class="n">b</span>·<span·class="o">=</span>·<span·class="mi">5</span> |
562 | <span·class="n">param</span><span·class="o">.</span><span·class="n">c</span>·<span·class="o">=</span>·<span·class="s1">'default·value'</span> | 562 | <span·class="n">param</span><span·class="o">.</span><span·class="n">c</span>·<span·class="o">=</span>·<span·class="s1">'default·value'</span> |
563 | <span·class="n">param</span><span·class="o">.</span><span·class="n">type</span>·<span·class="o">=</span>·<span·class="mi">0</span> | 563 | <span·class="n">param</span><span·class="o">.</span><span·class="n">type</span>·<span·class="o">=</span>·<span·class="mi">0</span> |
564 | <span·class="o">...</span> | 564 | <span·class="o">...</span> |
565 | </pre></div> | 565 | </pre></div> |
566 | </div> | 566 | </div> |