docs: Reviewed and tweaked wording in README.md #156
Conversation
| ### Connection Plugin Manager | ||
| Connection plugin manager initializes, triggers, and cleans up a chain of connection plugins. Connection plugins are widgets attached to each `Connection` objects to help execute additional or supplementary logic related to that `Connection`. [Enhanced Failure Monitoring](https://github.com/awslabs/aws-mysql-jdbc#enhanced-failure-monitoring) is one example of a connection plugin. | ||
| The connection plugin manager initializes, triggers, and cleans up a chain of connection plugins. Connection plugins are widgets attached to each `Connection` object to help execute additional or supplementary logic related to that `Connection`. [Enhanced Failure Monitoring](https://github.com/awslabs/aws-mysql-jdbc#enhanced-failure-monitoring) is one example of a connection plugin. |
There was a problem hiding this comment.
The more I look at it the more awkward this line looks.
Enhanced Failure Monitoring is one example of a connection plugin.
I think we should refer to the feature as Enhanced Failure Monitoring and refer the plugin as Enhanced Failure Monitoring Connection Plugin
There was a problem hiding this comment.
Would it be better phrased:
Enhanced Failure Monitoring is just one example of a connection plugin; you can use the 'Enhanced Failure Monitoring' Connection plugin to implement the functionality.
There was a problem hiding this comment.
I propose we rename Enhanced Failure Monitoring to Enhanced Failure Monitoring Plugin.
There was a problem hiding this comment.
Great, let's do that name change. I'll merge this PR in and we can open up another PR that does the renaming.
3 participants
Summary
Documentation review and changes for the upcoming 0.4.0 release.
Description
Connection Plugin ManagerandEnhanced Failure Monitoringsections.