Docs: Standardize and improve SentenceTransformersTextEmbedder docstrings #8060
Conversation
agnieszka-m
added
the
ignore-for-release-notes
| @component | ||
| class SentenceTransformersTextEmbedder: | ||
| """ | ||
| A component for embedding strings using Sentence Transformers models. |
There was a problem hiding this comment.
All other components in Haystack use one sentence for this docstring and many (not all) start with A component. If we change only the class SentenceTransformersTextEmbedder it's not really standardized.
There was a problem hiding this comment.
we're going to gradually change them all.
There was a problem hiding this comment.
the goal is also to shorten the docstrings and not repeat what's obvious, that's why I did away with "A component for.."
There was a problem hiding this comment.
@julian-risch "A component" is used often, but is not a standard (see DocumentWriter, CacheChecker, converters for examples), I would say that the shorter style that describes what component is doing looks quite good.
There was a problem hiding this comment.
@julian-risch are you OK with the new format? can I resolve this?
|
@dfokina @agnieszka-m I saw that the related PR #8057 mentions the PR is part of a series of changes. I suggest that you open one issue for the series of changes with a description of the required changes. |
haystack/components/embedders/sentence_transformers_text_embedder.py
Outdated
Show resolved
Hide resolved
Pull Request Test Coverage Report for Build 10093246889Details
💛 - Coveralls |
haystack/components/embedders/sentence_transformers_text_embedder.py
Outdated
Show resolved
Hide resolved
haystack/components/embedders/sentence_transformers_text_embedder.py
Outdated
Show resolved
Hide resolved
…der.py Co-authored-by: Daria Fokina <[email protected]>
…der.py Co-authored-by: Daria Fokina <[email protected]>
julian-risch
changed the title
There was a problem hiding this comment.
Looks good to me! 👍 Thank you also for creating the overview issue here #8062 What remains to be done is to better explain to the rest of the team what standards to follow when writing docstrings in future.
|
@julian-risch Absolutely, I'll document the standards for the docstrings. |
Related Issues
Proposed Changes:
Standardize and improve docstrings.
How did you test it?
Notes for the reviewer
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.