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

ResponseParser docs #76

Merged
merged 1 commit into from
Nov 23, 2022
Merged

ResponseParser docs #76

merged 1 commit into from
Nov 23, 2022

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Nov 21, 2022

There's no reason not to include at least very basic user-visible docs for ResponseParser. I've been using Net::IMAP::ResponseParser (both separate from and combined with the rest of the Net::IMAP client, both my forked version and the upstream version) for over a decade. 😄

Also, I want to consider adding some parser options, e.g. "#{provider} quirks mode" vs "strict mode" vs "support experimental draft rfc", and it would make the most sense to document options those here.

@nevans nevans added the documentation Improvements or additions to documentation label Nov 21, 2022
@nevans nevans force-pushed the response-parser-docs branch 2 times, most recently from 421309e to 66863a1 Compare November 22, 2022 14:53
@nevans
Copy link
Collaborator Author

nevans commented Nov 22, 2022

@shugo: the reference to nevans/rdoc has been removed from this PR. You can see the rendered result here: https://nevans.github.io/net-imap/Net/IMAP/ResponseParser.html (it's very minimal, for now)

Copy link
Member

@shugo shugo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks fine!

@nevans nevans merged commit e500d28 into master Nov 23, 2022
@nevans nevans deleted the response-parser-docs branch November 23, 2022 13:55
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.

2 participants