Review and normalize docstrings

[shadeMe]

Guidelines

Make sure the docstrings adhere to the following:

• Markdown syntax is correct.
  • c.f https://docs.readme.com/rdmd/docs/getting-started
• Component docstrings should be concise and not have information that's not directly associated with their code.
  • Format:

    •   """
        <A brief description of the component.>
      
        <An optional paragraph with additional details and references. Just one paragraph.>
      
        Usage example:
        <Example code block>
        """

• Links to external webpages are not bare/correctly formatted.
  • Don't directly use URLs but anchor text instead.
• Component Run method has the following format:

  •   """
      <One-liner describing the semantics of the run operation>
      
      <Parameter list for the inputs>
    
      <Output description. If a dict is returned, provide a bullet list 
      of all expected keys and a short description of their values; use inline code quotes for key names.>
      """

• Defaults/type annotations for parameters are not present in the docstring.
  • These are automatically generated.
• Use the following docstrings for standard functions:
  • warm_up:

    •   """
        Initializes the component.
        """

  • to_dict:

    •   """
        Serializes the component to a dictionary.
      
        :returns: 
        	Dictionary with serialized data.
        """

  • from_dict:

    •   """
        Deserializes the component from a dictionary.
      
        :param data:
            Dictionary to deserialize from.
        :returns:
        	Deserialized component.
        """

• Test the changes to the docstrings by rendering them locally using pydoc-markdown.

Scope

• Target all publicly visible classes.
• Private/internal classes can be more sparsely documented than their public counterparts.

Related tasks

• Test the usage example locally.
• Add missing docstrings.

Haystack Core

Preview Give feedback

1. Docstrings - haystack.components.audio #7098
   2.x P1 type:documentation +3
   
2. Docstrings - haystack.components.builders #7099
   2.x P1 type:documentation +3
   
3. Docstrings - haystack.components.caching #7100
   2.x P1 type:documentation +3
   
4. Docstrings - haystack.components.classifiers #7101
   2.x P1 type:documentation +3
   
5. Docstrings - haystack.components.connectors #7102
   2.x P1 type:documentation +3
   
6. Docstrings - haystack.components.converters #7103
   2.x P1 type:documentation +3
   
7. Docstrings - haystack.components.embedders #7104
   2.x P1 type:documentation +3
   
8. Docstrings - haystack.components.extractors #7106
   2.x P1 type:documentation +3
   
9. Docstrings - haystack.components.fetchers #7107
   2.x P1 type:documentation +3
   
10. Docstrings - haystack.components.generators #7108
    2.x P1 type:documentation +3
    
11. Docstrings - haystack.components.joiners #7109
    2.x P1 type:documentation +3
    
12. Docstrings - haystack.components.others #7110
    2.x P1 type:documentation +3
    
13. Docstrings - haystack.components.preprocessors #7111
    2.x P1 type:documentation +3
    
14. Docstrings - haystack.components.rankers #7112
    2.x P1 type:documentation +3
    
15. Docstrings - haystack.components.readers #7113
    2.x P1 type:documentation +3
    
16. Docstrings - haystack.components.retrievers #7114
    2.x P1 type:documentation +3
    
17. Docstrings - haystack.components.routers #7115
    2.x P1 type:documentation +3
    
18. Docstrings - haystack.components.samplers #7116
    2.x P1 type:documentation +3
    
19. Docstrings - haystack.components.validators #7117
    2.x P1 type:documentation +3
    
20. Docstrings - haystack.components.websearch #7118
    2.x P1 type:documentation +3
    
21. Docstrings - haystack.components.writers #7119
    2.x P1 type:documentation +3
    
22. Docstrings - haystack.core #7120
    2.x P1 type:documentation +3
    
23. Docstrings - haystack.dataclasses #7121
    2.x P1 type:documentation +3
    
24. Docstrings - haystack.document_stores #7122
    2.x P1 type:documentation +3
    
25. Docstrings - haystack.templates #7123
    2.x P1 type:documentation +3
    
26. Docstrings - haystack.utils #7124
    2.x P1 type:documentation +3
    

Haystack Core Integrations

Preview Give feedback

1. Docstrings - integrations.amazon_bedrock #7127
   2.x P1 type:documentation +3
   
2. Docstrings - integrations.amazon_sagemaker #7128
   2.x P1 type:documentation +3
   
3. Docstrings - integrations.astra #7129
   2.x P1 type:documentation +3
   
4. Docstrings - integrations.chroma #7130
   2.x P1 type:documentation +3
   
5. Docstrings - integrations.cohere #7131
   2.x P1 type:documentation +3
   
6. Docstrings - integrations.deepeval #7132
   2.x P1 type:documentation +3
   
7. Docstrings - integrations.elasticsearch #7133
   2.x P1 type:documentation +3
   
8. Docstrings - integrations.fastembed #7134
   2.x P1 type:documentation +3
   
9. Docstrings - integrations.google_ai #7135
   2.x P1 type:documentation +3
   
10. Docstrings - integrations.google_vertex #7136
    2.x P1 type:documentation +3
    
11. Docstrings - integrations.gradient #7137
    2.x P1 type:documentation +3
    
12. Docstrings - integrations.instructor_embedders #7138
    2.x P1 type:documentation +3
    
13. Docstrings - integrations.jina #7139
    2.x P1 type:documentation +3
    
14. Docstrings - integrations.llama_cpp #7140
    2.x P1 type:documentation +3
    
15. Docstrings - integrations.mistral #7141
    2.x P1 type:documentation +3
    
16. Docstrings - integrations.mongodb_atlas #7142
    2.x P1 type:documentation +3
    
17. Docstrings - integrations.ollama #7143
    2.x P1 type:documentation +3
    
18. Docstrings - integrations.opensearch #7144
    2.x P1 type:documentation +3
    
19. Docstrings - integrations.optimum #7145
    2.x P1 type:documentation +3
    
20. Docstrings - integrations.pgvector #7146
    2.x P1 type:documentation +3
    
21. Docstrings - integrations.pinecone #7147
    2.x P1 type:documentation +3
    
22. Docstrings - integrations.qdrant #7148
    2.x P1 type:documentation +3
    
23. Docstrings - integrations.ragas #7149
    2.x P1 type:documentation +3
    
24. Docstrings - integrations.unstructured #7150
    2.x P1 type:documentation +3
    
25. Docstrings - integrations.uptrain #7151
    2.x P1 type:documentation +3
    
26. Docstrings - integrations.weaviate #7152
    2.x P1 type:documentation +3