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

Improve docstrings #230

Merged
merged 2 commits into from
Dec 30, 2020
Merged

Improve docstrings #230

merged 2 commits into from
Dec 30, 2020

Conversation

cmcaine
Copy link
Contributor

@cmcaine cmcaine commented Dec 27, 2020

614471b (Colin Caine, 19 seconds ago)
Document SSLConfig methods

99dcf55 (Colin Caine, 34 seconds ago)
Give signature in docs for Base. methods

@cmcaine
Copy link
Contributor Author

cmcaine commented Dec 27, 2020

Otherwise using MbedTLS pollutes Base's docstrings:

help?> close
search: close CIPHER_BLOWFISH

  close(stream)

  Close an I/O stream. Performs a flush first.

  ──────────────────────────────────────────────

  close(c::Channel[, excp::Exception])

  Close a channel. An exception (optionally given by excp), is thrown by:

    •  put! on a closed channel.

    •  take! and fetch on an empty, closed channel.

  ──────────────────────────────────────────────

  Send a TLS close_notify message to the peer.

Copy link
Member

@quinnj quinnj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@quinnj quinnj merged commit ec0d189 into JuliaLang:master Dec 30, 2020
@cmcaine cmcaine deleted the docs branch December 30, 2020 08:50
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