Skip to content

Commit

Permalink
fix small typo in Document doc string (#2520)
Browse files Browse the repository at this point in the history
* fix small typo in Document doc string

Was going through the tutorial, then digging through the code and just noticed a small typo

* generate markdown file changes from docstrings

Co-authored-by: Julian Risch <[email protected]>
  • Loading branch information
galtay and julian-risch authored May 9, 2022
1 parent bce8457 commit 9885688
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/_src/api/api/primitives.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There's an easy option to convert from/to dicts via `from_dict()` and `to_dict`.
**Arguments**:

- `content`: Content of the document. For most cases, this will be text, but it can be a table or image.
- `content_type`: One of "image", "table" or "image". Haystack components can use this to adjust their
- `content_type`: One of "text", "table" or "image". Haystack components can use this to adjust their
handling of Documents and check compatibility.
- `id`: Unique ID for the document. If not supplied by the user, we'll generate one automatically by
creating a hash from the supplied text. This behaviour can be further adjusted by `id_hash_keys`.
Expand Down
2 changes: 1 addition & 1 deletion haystack/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def __init__(
There's an easy option to convert from/to dicts via `from_dict()` and `to_dict`.
:param content: Content of the document. For most cases, this will be text, but it can be a table or image.
:param content_type: One of "image", "table" or "image". Haystack components can use this to adjust their
:param content_type: One of "text", "table" or "image". Haystack components can use this to adjust their
handling of Documents and check compatibility.
:param id: Unique ID for the document. If not supplied by the user, we'll generate one automatically by
creating a hash from the supplied text. This behaviour can be further adjusted by `id_hash_keys`.
Expand Down

0 comments on commit 9885688

Please sign in to comment.