testcontainers-rs icon indicating copy to clipboard operation
testcontainers-rs copied to clipboard

Usage examples in rustdoc

Open TheButlah opened this issue 5 years ago • 1 comments

Would it be possible to provide a minimal usage example directly in the rustdocs? Hints on how to get started are provided, but having a minimal complete example would go a long way (new user here).

TheButlah avatar Sep 01 '20 20:09 TheButlah

I guess we could have rustdoc examples that are tagged with norun to avoid spinning up too many containers during testing.

Generally, we try to have integration tests for every important features so checking out the tests might also help with getting started :)

I can see how that is not super obvious though so we should probably add docs that say that AND provide some rustdoc examples :)

thomaseizinger avatar Sep 14 '20 07:09 thomaseizinger