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

Change wording in README.md #39

Merged
merged 2 commits into from
Nov 12, 2023
Merged

Change wording in README.md #39

merged 2 commits into from
Nov 12, 2023

Conversation

preciz
Copy link
Contributor

@preciz preciz commented Nov 12, 2023

In the README.md currently it says:

First we start the port:

      iex> child = {NimblePool, worker: {PortPool, :cat}, name: PortPool}
      iex> Supervisor.start_link([child], strategy: :one_for_one)

I believe this is confusing since what we are starting is a pool of ports synchronously not "the port".

In the following example in the README.md:

  First we start the connection:

      child = {NimblePool, worker: {HTTP1Pool, {:https, "elixir-lang.org", 443}}, name: HTTP1Pool}
      Supervisor.start_link([child], strategy: :one_for_one)

Here then below what it does it starts the pool which has :async worker initialization, so I think here also the
"the connection" should be changed.

This is why I opened this PR, I hope I'm not missing any details. Thanks for reviewing.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@josevalim josevalim merged commit 792fbd2 into dashbitco:main Nov 12, 2023
2 checks passed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

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

Successfully merging this pull request may close these issues.

2 participants