New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documenting tasks via docstrings #1081
Labels
good first issue
Good for newcomers
Comments
Acceptance Criteria:
|
A Changelog entry is also needed. |
Hi, can I work on this? |
Hey @Kaushal-Dhungel this one is already assigned, please pick a different |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: