You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have a feature that isn't documented, from a user:
Hi, how do I define the documentation for a particular task in the pipeline? When I run ploomber status, I see the column Doc(short) which is always empty. A follow-up question is can I customize the status report ?
the documentation is extracted from the docstrings (if your function is a task); alternatively, if your task is a script or a notebook, you can define a string at the top of a markdown cell. example:
documentation for my script/notebook
In case of functions that look like the following:
if you want to customize the output of ploomber status you can use the Python API, you can load your pipeline with this,
then call dag.status() and then you can manipulate the object. here's the Table object that it'll return:
We have a feature that isn't documented, from a user:
the documentation is extracted from the docstrings (if your function is a task); alternatively, if your task is a script or a notebook, you can define a string at the top of a markdown cell. example:
In case of functions that look like the following:
This is how you add the docstring:
if you want to customize the output of ploomber status you can use the Python API, you can load your pipeline with this,
then call
dag.status()
and then you can manipulate the object. here's the Table object that it'll return:ploomber/src/ploomber/table.py
Line 69 in 2a6287f
We should document this functionality.
The text was updated successfully, but these errors were encountered: