search

aatxe / irc

the irc crate – usable, async IRC for Rust
Mozilla Public License 2.0
530 stars 97 forks source link

`Command::JOIN`'s docs don't explain the last `Option<String>` field #90

Closed niconii closed 7 years ago

niconii commented 7 years ago

Link

    /// JOIN chanlist [chankeys]
    JOIN(String, Option<String>, Option<String>),

It looks like it's part of this extension, being for the :Real Name field, but it's a bit confusing when there's nothing to really explain this or what the extra field is for, besides a passing mention later on that JOIN has something to do with 3.1 extensions:

    // IRCv3.1 extensions
    ...
    // JOIN is already defined.
    // JOIN(String, Option<String>, Option<String>),
aatxe commented 7 years ago

That's exactly correct. I'll update the docs! Thanks!