Doc: fix return
example as @example only allows one line
#889
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The doc does not display example of
return
option properly in https://www.rubydoc.info/gems/elasticsearch-model/Elasticsearch/Model/Importing/ClassMethods:importThis is because yard doc only allows
@example
title to be single line, but here we made it multi-line.I've also updated the
@return
tag to indicate it can be changed.Lastly, "Update the batch before yielding it" example does not render the last code line, because the indentation is inconsistent. That's fixed too.