📚 Update SASL docs and add attr_readers #176
Merged
Conversation
This file contains 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
The rdoc output is improved simply by making some constants private and `#initialize` public, Except for changing visibility, no code was changed (only rearranged).
This also renames `@user` to `@username`, to match other authenticators. However, the spec is unclearly worded. It arguably _should_ be renamed to (or aliased as) `authzid`. 🤷
Also renamed ivars to match the names used by other authenticators. However... `DIGEST-MD5` is still deprecated, so don't use it! 😉
37 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Because the documentation for
Net::IMAP#authenticateandNet::IMAP::SASLboth point at the individual authenticators to document their own parameters, it's important that all of the authenticators have documentation of their own.PLAINandXOAUTH2in particular both needed more documentation than they had. This PR fixes that, in addition to a few other documentation-related changes.Each configuration parameter was given an
attr_reader(except for CRAM-MD5 and LOGIN, which are deprecated). In addition to being useful for debugging, the attributes are documented in more detail than the same#initializeparameters. In a few cases, ivars were renamed to normalize the parameter names between different authenticators.Several internal-use constants were made
private, which also removes them from the rdoc.Several authenticator class definitions were re-ordered to place
#initializeabove all other methoddefs (after constants andattr_readers). By moving them out of theprivatesection, rdoc now documents the method parameters for them.