🐛 Fix mailbox attrs #73
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
nevans
added
bug
This was referenced Nov 21, 2022
shugo
reviewed
Nov 22, 2022
nevans
force-pushed
the
fix-mailbox-attrs
branch
from
5411897
to
5c61dfb
Compare
|
@shugo Thanks for catching my |
Prepended modules are to: * Fix `:section:` comments * Convert the "note" list type to tables, like the hanna-nouveau format. Unlike hanna-nouveau, label lists remain lists. * remove redundant "()" from methods Add basic stylesheet tweaks to give more visual separation between methods, make the navbar sticky, fix *bold* font-weight, etc. n.b. some of these styles look best with a couple of rdoc darkfish patches which have not (yet?) been accepted.
* Fix formatting and linking that wasn't obviously wrong before, because rdoc wasn't rendering the section comments before. * Add some missing links. * Update mailbox attributes section names * link to #list * simplify section names
Now the constants match Net::IMAP's behavior, so they can be used for comparison. Also add docs and aliases for flag and mailbox attrs. Because the consts are ALL_CAPS, it's nicer to use underscore versions.
nevans
force-pushed
the
fix-mailbox-attrs
branch
from
5c61dfb
to
e622732
Compare
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.
I don't think many people use the Mailbox Attr and flags constants, but I had incorrectly capitalized some of them, so they didn't all work anyway. I intend to submit a future PR that does use these constants for some simple predicate methods, and that requires fixing them first.
Additionally, the first commit 6624000 (shared with several other PRs) fixes a long-outstanding issue with RDoc: section comments aren't rendered. I don't think that the way that I've fixed it here is ultimately the Right Way to fix it, but I want to push our updated documentation to https://ruby.github.io/net-imap, and my patched
rdocwill work very well for that.Once my rdoc fork was able to render the section comments, I made some significant formatting changes so it all reads much more nicely now.