elasticsearch-ruby

https://github.com/elastic/elasticsearch-ruby

Ruby

Ruby integrations for Elasticsearch

Elasticsearch::API::Actions#explain

Return information if and how well a document matches a query.

The returned information contains a `_score` and its explanation, if the document matches the query.

Source | Google | Stack overflow

Edit

git clone [email protected]:elastic/elasticsearch-ruby.git

cd elasticsearch-ruby

open elasticsearch-api/lib/elasticsearch/api/actions/explain.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Elasticsearch--API--Actions-explain-for-pr

# Commit to git

git add elasticsearch-api/lib/elasticsearch/api/actions/explain.rbgit commit -m "better docs for Elasticsearch::API::Actions#explain"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Elasticsearch--API--Actions-explain-for-pr

hub pull-request

# Celebrate!