haystack icon indicating copy to clipboard operation
haystack copied to clipboard

docs: Run vs Initialization parameters

Open TuanaCelik opened this issue 1 year ago • 2 comments

When we first started creating the Haystack 2.0 docs we had a standard for making sure we list the inputs for the component torun() the component as well as the Parameters/Initialization Parameter But I don't think we do this anymore.

It would be super useful if we did this consistently.

Example: DocumentWriter This component expects documents to run, but expects a document_store at initialization. This fact is only shown in the code snippet.

TuanaCelik avatar Aug 22 '24 13:08 TuanaCelik

I second this. Was stumped for a while trying to figure it out.

aantti avatar Aug 22 '24 13:08 aantti

Yess

Boben19 avatar Aug 23 '24 13:08 Boben19

I introduced the changes with the new component table format. The changes are live from v.2.6 onward.

Example: https://docs.haystack.deepset.ai/v2.6-unstable/docs/documentwriter

dfokina avatar Sep 17 '24 11:09 dfokina