docs: Pipeline.inputs() #8271
Labels
P2
Medium priority, add to the next sprint if no P1 available
topic:pipeline
type:documentation
Improvements on the docs
Once a pipeline is created, it's difficult for users to know how they should run the pipeline. We have quite a useful utility function for pipelines which is
.inputs()
which lists all the expected/required inputs for the components.We should use this in our docs heavily imo. This function is hardly visible, and we don't really provide any help on how a pipeline should be run other than trial and errors. Once a pipeline fails, the error us quite handy. And if a user knows to ues
.show()
that is also handy. But I think we should add this everywhere as something that a user colud make use of while creating/running pipelines.The text was updated successfully, but these errors were encountered: