search

aatxe / irc

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

Typo in comment? #73

Closed danielniccoli closed 7 years ago

danielniccoli commented 7 years ago

Shouldn't this say the following?

/// Handles CTCP requests if the CTCP feature is disabled.

https://github.com/aatxe/irc/blob/master/src/client/server/mod.rs#L489

aatxe commented 7 years ago

Strictly speaking, all the doc comments are written in a manner such that a reader can identify what features are toggleable. So, this says "enabled" because if you were reading it in docs, you wouldn't know necessarily which flag the docs were generated with. That being said, since this is a private function, I don't think the comment actually appears anywhere in the documentation. I suppose it wouldn't matter much either way.