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

SecureWithTLSSettings additions to the Haddock documentation #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

taladar
Copy link

@taladar taladar commented Jan 17, 2017

I started using the recent additions from my other pull requests. Since it took me a while to figure out how to use them for this relatively common purpose (common to people who want to use this at all) I figured it might be helpful to have my connection test code as an example in the docs.

I put it into the docs for the Host type so it isn't so overwhelming for people who just get started with the library. If you know a better place I am open to changes.

It is mostly just a dump of my test code so I am sure it could be improved, though it should be relatively self-explanatory.

If you decide not to merge my other open merge request (SASL EXTERNAL auth) you should replace the last line of the example with one of the other bind operations. They work as they usually do.

@supki
Copy link
Owner

supki commented Feb 23, 2017

Sorry for the late reply. (I somehow missed the notification email GitHub sent me.)

I think this kind of example code is great, but I'd like it better if it were a separate file in the examples directory which the user can run directly (once she figures out how to install the dependencies).

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.

None yet

2 participants