duesee / duesee/imap-codec

docs: improve imap-types documentation (mentioning `Try{,From}`, valid inputs, etc.

Open
#358 2 comments 1 reaction 1 assignee Claimed by @duesee View on GitHub
community documentation enhancement good first issue
Dominant language
Rust
Stars
52
Forks
25
Avg merge
21h 53m
Merged PRs (30d)
2

Description

E.g. `Quoted` has documentation that explains its meaning and how it is represented on the wire. But IMO the following information is important but missing:

- That `TryFrom` and `From` are the main constructors
- What inputs are invalid regarding the Rust API (e.g. the wire format of `Quoted` forbids unquoted `"`, but not the Rust API)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.