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

Improve DockerCompose documentation

Open Ledmington opened this issue 3 years ago • 2 comments

Hi. I'm starting to use testcontainers to test the behavior of a simple P2P network written in Python. I noticed that the auto-generated documentation for each class is just a copy of the constructor (without parameters descriptions) and a small code example. It would be really helpful if, at least, a small description of the behavior of each available method for each class was provided. Then this could be improved by adding a small description of the meaning of each parameter.

Small addition: for some reason, the documentation has really big margins on the left and the right but the title is too long. Screenshot (113)

Ledmington avatar Dec 14 '21 09:12 Ledmington

An example of what i'm saying: only yesterday i discovered that testcontainers.core.waiting_utils contains some useful (to say the least) functions such as wait_container_is_ready and wait_for_logs that are missing from the documentation.

Ledmington avatar Apr 04 '22 21:04 Ledmington

I added docstrings for the docker compose module in #198, however as you mentioned is still missing documentation elsewhere like the core module

kieranlea avatar Apr 04 '22 22:04 kieranlea