-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Improved readability in Readme.md #2058
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, good catch. But as I am reading both versions, neither of them make any sense.
Do you think the below wording would be acceptable?
|
So it looks that that is meant to replace more than the one paragraph updated in the PR? Can you either (a) update the PR so I can tell what exactly this is replacing or (b) write in the comments here the section that that wording would replace? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just the one comment, otherwise LGTM. Please post a comment when you update the PR with a change, though, as otherwise I don't know when you push a new change.
since they have a pending `QUIT` packet in their queue; wait until releasing | ||
all connections back to the pool before calling `pool.end()`. | ||
|
||
Since the `pool.query` method is a short-hand for the `pool.getConnection` -> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you find a spot to keep the note about it being a short-hand for the three methods? A user previously added that part to this section because they were confused without it. I would like to keep it there for them if possible.
Indeed, it makes sense to add this reminder here. |
I removed a few spurious words from a paragraph in Readme.md. I assume these were inadvertently left in a previous change.