https://dev.arvados.org/https://dev.arvados.org/favicon.ico?15576888422018-05-16T15:00:59ZArvadosArvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=627312018-05-16T15:00:59ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Description</strong> updated (<a title="View differences" href="/journals/62731/diff?detail_id=59735">diff</a>)</li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=630812018-06-04T14:04:49ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Related to</strong> <i><a class="issue tracker-2 status-6 priority-4 priority-default closed" href="/issues/5214">Feature #5214</a>: [SDKs] Use sphinx to render for Python SDK docs</i> added</li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=631142018-06-04T19:09:54ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Currently leaning towards Doxygen as our alternative for documentation generation. It is very capable and customizable.</p> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=649652018-07-25T14:07:22ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Related to</strong> <i><a class="issue tracker-2 status-7 priority-4 priority-default closed" href="/issues/6865">Feature #6865</a>: [Documentation] Higher Level Python SDK Reference Page</i> added</li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=730392019-04-03T17:04:10ZTom Morristfmorris@veritasgenetics.com
<ul><li><strong>Related to</strong> <i><a class="issue tracker-6 status-7 priority-4 priority-default closed parent" href="/issues/15015">Idea #15015</a>: replace epydoc</i> added</li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=942562021-07-06T21:10:23ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> deleted (<del><i>To Be Groomed</i></del>)</li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1077472022-11-08T19:46:52ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> set to <i>2022-11-23 sprint</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1077622022-11-08T19:53:56ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Category</strong> set to <i>SDKs</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1078322022-11-09T17:00:37ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-11-23 sprint</i> to <i>2022-12-07 Sprint</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1082842022-11-22T19:34:53ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-12-07 Sprint</i> to <i>2022-12-21 Sprint</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1084032022-11-23T18:14:51ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-12-21 Sprint</i> to <i>2023-01-18 sprint</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1094502023-01-03T17:25:38ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-01-18 sprint</i> to <i>2023-02-01 sprint</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1094872023-01-03T17:51:17ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Tracker</strong> changed from <i>Bug</i> to <i>Feature</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1094882023-01-03T17:51:21ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Tracker</strong> changed from <i>Feature</i> to <i>Support</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1096632023-01-11T17:56:46ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-02-01 sprint</i> to <i>Future</i></li></ul> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1098642023-01-11T22:54:20ZBrett Smithbrett.smith@curii.com
<ul></ul><p>IMO we should merge this ticket with <a class="issue tracker-6 status-2 priority-4 priority-default behind-schedule" title="Idea: Update Python SDK documentation (In Progress)" href="https://dev.arvados.org/issues/18800">#18800</a>, or else close it as being redundant. I don't think this ticket covers anything that isn't already covered better there, except for suggesting switching to a different documentation system, which was done in <a class="issue tracker-1 status-3 priority-4 priority-default closed parent" title="Bug: [build] replace python-epydoc in our build environment (Resolved)" href="https://dev.arvados.org/issues/16833">#16833</a>.</p> Arvados - Support #13418: Python SDK must have docstrings for all public interfaceshttps://dev.arvados.org/issues/13418?journal_id=1098782023-01-11T23:00:19ZBrett Smithbrett.smith@curii.com
<ul><li><strong>Related to</strong> <i><a class="issue tracker-6 status-2 priority-4 priority-default behind-schedule" href="/issues/18800">Idea #18800</a>: Update Python SDK documentation</i> added</li><li><strong>Related to</strong> <i><a class="issue tracker-1 status-3 priority-4 priority-default closed parent" href="/issues/16833">Bug #16833</a>: [build] replace python-epydoc in our build environment</i> added</li></ul>