This message was deleted.
# ask-anything
s
This message was deleted.
i
Do you mean when running
ploomber status
?
Check the task api, you can probably use python to edit the Doc as a workaround. What’s the use case?
e
I just realized this is undocumented: 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:
Copy code
"""documentation for my script/notebook
"""
👍 1
what customizations do you want to apply to the report?
n
This was what I was looking for. A simple documentation for internal stakeholders. It also would be great if we can exclude some columns like last run or outdated. I am not sure what outdated means here.
Thank you
So my task/scripts look like the following:
*def* func1():
...
*def* func2():
...
*if* __name__ *==* "__main__":
func1()
func2()
where should I add the docstring?
e
to add the docstring:
Copy code
def func():
    """some comment"""
    ...
if you want to customize the output of
ploomber status
you can use the Python API, you can load your pipeline with this: https://docs.ploomber.io/en/latest/cookbook/spec-load-python.html then call
dag.status()
and then you can manipulate the object, this is undocumented, so I can help if you have issues. here's the Table object that it'll return: https://github.com/ploomber/ploomber/blob/2a6287f1beea9f51ecbe59ddebac266cef6c77e8/src/ploomber/table.py#L69
👍 1
n
Thank you
e
feel free to post any other questions!
i
Opened an issue, @Nil if you’re up for it we’re happy to guide you on a PR!