elastic / elasticsearch-rs

Official Elasticsearch Rust Client
https://www.elastic.co/guide/en/elasticsearch/client/rust-api/current/index.html
Apache License 2.0
702 stars 72 forks source link

Add markdown examples into generated client #73

Closed russcam closed 4 years ago

russcam commented 4 years ago

This commit adds Markdown documentation into the client, providing a way to document generated APIs.

When generating APIs, files will be looked for in the elasticsearch/docs directory corresponding to a naming convention. If found, the contents are included in the generated doc attribute.

Because the markdown docs are included in the client, examples are tested when cargo test runs.

Closes #66 Closes #67