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

📚 Update IMAP#search docs (again) #360

Merged
merged 1 commit into from
Dec 14, 2024
Merged

📚 Update IMAP#search docs (again) #360

merged 1 commit into from
Dec 14, 2024

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Dec 14, 2024

Now that rdoc 6.8 renders properly on small screens, the IMAP#search docs needed to be updated. Nested unordered lists indent too deeply for small screens.

Also, the search rdoc reads better when the details of argument translation are moved from the main text into its own subsection.

Also, the search key reference has been reorganized around key type.

Also, the heading levels were all adjusted to h4 and h5. This assumes that the method heading is an h3 heading. Unfortunately, the method headings use a <div>, but they should be h3 headings. 😉

@nevans nevans added the documentation Improvements or additions to documentation label Dec 14, 2024
Now that rdoc 6.8 renders properly on small screens, the IMAP#search
docs needed to be updated.  Nested unordered lists indent too deeply for
small screens.

Also, the search rdoc reads better when the details of argument
translation are moved from the main text into its own subsection.

Also, the search key reference has been reorganized around key type.

Also, the heading levels were all adjusted to `h4` and `h5`.  This
assumes that the method heading is an `h3` heading.  Unfortunately, the
method headings use a `<div>`, but they _should_ be `h3` headings. 😉
@nevans nevans merged commit f6cf182 into master Dec 14, 2024
30 checks passed
@nevans nevans deleted the search-rdoc branch December 14, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

1 participant