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

Wrong or misleading function names in protocol #84

Closed
jarlah opened this issue Apr 21, 2024 · 1 comment · Fixed by #93
Closed

Wrong or misleading function names in protocol #84

jarlah opened this issue Apr 21, 2024 · 1 comment · Fixed by #93
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jarlah
Copy link
Collaborator

jarlah commented Apr 21, 2024

This

https://github.com/testcontainers/testcontainers-elixir/blob/main/lib/container/protocols/container_builder.ex#L9

is saying something in the lines of "return ok if the container is starting", but its really a "call this function if the container has started".

Consider better naming of the function and add docs

@jarlah jarlah added the documentation Improvements or additions to documentation label Apr 21, 2024
@jarlah
Copy link
Collaborator Author

jarlah commented Apr 23, 2024

also fix the kafka container documentation for this method

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant