elastic-rs / elastic

An Elasticsearch REST API client for Rust
Apache License 2.0
253 stars 40 forks source link

fix some doc links #393

Closed TomPridham closed 4 years ago

TomPridham commented 4 years ago

fixed some relative links to different docs. i also changed the docs in the BulkErrorsResponse section to more explicitly call out the method required to get BulkErrorsResponse as the return type from the client

mwilliammyers commented 4 years ago

Hey @TomPridham! Thanks for the PR! I have been meaning to cleanup those links for a while. 👍🏼

Any chance you could fix those doc-test compilation errors when you get a chance, so we can merge this in?

TomPridham commented 4 years ago

yeah, sure. is that just cargo test --doc?

mwilliammyers commented 4 years ago

That would work to test just the doc tests or cargo test also includes them.

Is there a reason you got rid of the (hidden) do_request() functions in the docs? That is causing the issues...

mwilliammyers commented 4 years ago

Thanks for the PR!