django-haystack / django-haystack/django-haystack
Update `boost` documentation to indicate only "content" is affected
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.7k
- Forks
- 1.3k
- Avg merge
- 3h 18m
- Merged PRs (30d)
- 3
Description
The boost documentation on SearchQuerySet should be updated to indicate that only the "content" field is affected.
eg:
diff --git a/docs/searchqueryset_api.rst b/docs/searchqueryset_api.rst
index 2f71f62..02f6596 100644
--- a/docs/searchqueryset_api.rst
+++ b/docs/searchqueryset_api.rst
@@ -263,6 +263,11 @@ Example::
SearchQuerySet().filter(content='foo').boost('bar', 1.5)
+.. note::
+
- Boosting a term affects the query result by weighting the specified term in the
contentfield only. It does not apply to any other fields.
facet
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/searchqueryset_api.rst at the SearchQuerySet boost section and review the existing example. Update the documentation to state that boosting affects only the content field, then verify that the rendered section clearly communicates that other fields are unaffected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100