📚 Various documentation updates - #763
Merged
Merged
Conversation
This should've been updated for v0.6.0.
In addition to minor changes to a some of the documentation text, this adds some missing methods and attributes and a couple of new sections.
Emphasizes that these attributes to _NOT_ indicate a secure connection.
This is especially usefor for Config, since rdoc doesn't include attributes in the sidebar method list.
This simplifies some of the examples to to remove unnecessary confusing bits, or to operate on message sets without looping. This also updates them to use more modern features and work in more situations. More documentation is added to the Net::IMAP class rdoc examples, linking to the various commands. The README examples have been updated to match, but the text has been intentionally left out to keep it simple and clean. These are only meant as simple examples, so they're still missing error handling that would be needed in a production system.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
responsesfrozen_dupdocumentation (should've been updated by v0.6.0).Net::IMAP"What's here" list.Net::IMAP"What's here" list.ssl_ctxandssl_ctx_paramsrdoc.Net::IMAP::ConfigNet::IMAPclass rdoc