-
Notifications
You must be signed in to change notification settings - Fork 29
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
Net::IMAP Client docs #74
Commits on Dec 19, 2022
-
📚 Update Net::IMAP docs, formatting and more...
* Escape some text that shouldn't be linked, e.g. IMAP. * Link some text that should be linked: * removing "+" to let classes link * Remove `Net::IMAP::` prefix from response data class names. The redundant prefix breaks up the reading flow of the text. Examples will still use fully-qualified names, and readers should generally be able to see that the classes/modules are in Net::IMAP, from context. * Add headings and convert text to headings. * Reduce headings inside method docs to h5 (call-seq renders like h4). * Add <tt> or "+" to code or verbatim text. * To match the tweaks to rdoc's darkfish template, convert definition lists to "note" vs "label" style lists for table vs lists. * Add ">>>" with <em> to highlight important "aside" notices. * Add :nodoc: to ResponseErrors.
Configuration menu - View commit details
-
Copy full SHA for 864b797 - Browse repository at this point
Copy the full SHA 864b797View commit details -
📚 Update capabilities documentation
* Document capabilities at the class-level, linking to #capability for details. * Add "Basic IMAP4rev1 capabilities" and "Using IMAP4rev1 extensions" sections to the #capability rdoc. * Add relevant capabilities to the rdoc for every command extension. * Update existing capability docs to the same consistent format. * Add TODO comment for unsupported LIST-EXTENDED
Configuration menu - View commit details
-
Copy full SHA for c115a95 - Browse repository at this point
Copy the full SHA c115a95View commit details -
📚 Document the RFC specification for each command
Every IMAP command method now links to the RFC section that defines it.
Configuration menu - View commit details
-
Copy full SHA for c2b3528 - Browse repository at this point
Copy the full SHA c2b3528View commit details -
📚 Add "Related:" rdoc for most Net::IMAP methods
There are a lot of IMAP commands! This makes it easier to navigate between them. Hopefully this makes it easier to learn the IMAP4rev1 protocol and its extensions, as well.
Configuration menu - View commit details
-
Copy full SHA for 3c90cec - Browse repository at this point
Copy the full SHA 3c90cecView commit details -
📚 Document UIDPLUS commands, response codes, data
* Link to UIDPlusData for commands that can return it: `#append`, `#copy`, and `#move` * Update `#uid_expunge` to avoid "UID set", which has slightly different semantics from "sequence set of UIDs".
Configuration menu - View commit details
-
Copy full SHA for b0e91f7 - Browse repository at this point
Copy the full SHA b0e91f7View commit details -
📚 Document EXPUNGE, fetch/store/search, idle/noop
* Add paragraph to class-level docs, about expunge messages. * Add explanation to #noop docs, explaining EXPUNGE responses * Update #uid_expunge docs with method link instead of command name.
Configuration menu - View commit details
-
Copy full SHA for be253f3 - Browse repository at this point
Copy the full SHA be253f3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 200757e - Browse repository at this point
Copy the full SHA 200757eView commit details
Commits on Dec 21, 2022
-
📚 Update docs for #authenticate, #login, etc...
The documentation on these methods is meant to complement a new SASL::Authenticator base class and new documentation on each of the individual authenticator classes. See #78 and #82. That base class is added in another PR (#78), but the documentation for these methods can be updated without it. Also, somehow I misremembered `LOGINDISABLED`: it only applies to `LOGIN`, not `AUTHENTICATE`! This fixes that error.
Configuration menu - View commit details
-
Copy full SHA for 5343336 - Browse repository at this point
Copy the full SHA 5343336View commit details -
📚 Update #uid_fetch documentation
Add a note about the implicit UID message data item.
Configuration menu - View commit details
-
Copy full SHA for c76e9d6 - Browse repository at this point
Copy the full SHA c76e9d6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 32dfda9 - Browse repository at this point
Copy the full SHA 32dfda9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0963ef1 - Browse repository at this point
Copy the full SHA 0963ef1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5717f63 - Browse repository at this point
Copy the full SHA 5717f63View commit details -
📚 Document "What's here?" for Net::IMAP class
This "What's here?" section is based on the new documentation style for many core ruby classes. It isn't purely a list of methods; paragraphs of explanatory text are interspersed. *Many* "TODO" comments are added too, hidden from rdoc by `--` and `++`.
Configuration menu - View commit details
-
Copy full SHA for 4c9bf81 - Browse repository at this point
Copy the full SHA 4c9bf81View commit details -
Configuration menu - View commit details
-
Copy full SHA for fb82ed0 - Browse repository at this point
Copy the full SHA fb82ed0View commit details -
Without resetting to the default section, code that's loaded later may be documented in the wrong place
Configuration menu - View commit details
-
Copy full SHA for 1707249 - Browse repository at this point
Copy the full SHA 1707249View commit details -
Configuration menu - View commit details
-
Copy full SHA for bd04eb5 - Browse repository at this point
Copy the full SHA bd04eb5View commit details
Commits on Dec 22, 2022
-
Configuration menu - View commit details
-
Copy full SHA for 7ce966c - Browse repository at this point
Copy the full SHA 7ce966cView commit details