Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: fix return example as @example only allows one line #889

Merged
merged 1 commit into from Jul 18, 2019

Conversation

lulalala
Copy link
Contributor

@lulalala lulalala commented Jul 17, 2019

The doc does not display example of return option properly in https://www.rubydoc.info/gems/elasticsearch-model/Elasticsearch/Model/Importing/ClassMethods:import

This 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.

@estolfo
Copy link
Contributor

estolfo commented Jul 18, 2019

Thanks @lulalala !

@estolfo estolfo merged commit 4b3046f into elastic:master Jul 18, 2019
@lulalala lulalala deleted the doc-fix-import branch July 18, 2019 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants