search

numberoverzero / bottom

asyncio-based rfc2812-compliant IRC Client
http://bottom-docs.readthedocs.io
MIT License
74 stars 23 forks source link

some doc fixes #45

Closed Yay295 closed 7 years ago

Yay295 commented 7 years ago

For the ping and pong examples, should # server2 requires server1 be # server1 requires server2, or should client.send('PING', server2='tolsun.oulu.fi') be client.send('PING', server1='tolsun.oulu.fi')?

codecov[bot] commented 7 years ago

Codecov Report

Merging #45 into master will decrease coverage by <.01%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master     #45      +/-   ##
=========================================
- Coverage   99.31%   99.3%   -0.01%     
=========================================
  Files           5       5              
  Lines         436     434       -2     
  Branches      119     119              
=========================================
- Hits          433     431       -2     
  Misses          2       2              
  Partials        1       1
Impacted Files Coverage Δ
bottom/pack.py 100% <100%> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bab0f3b...15bbeb5. Read the comment docs.

numberoverzero commented 7 years ago

Thanks for the PR!

I'm not sure about the PING question; that looks like something that came from the RFC example and got mangled. It's almost certainly wrong but I haven't read the spec in some time. Any ideas?

The rest looks great. You can add yourself to contributors if you'd like.

Yay295 commented 7 years ago

Actually, I got that wrong. JOIN 0 does make you leave all channels, as silly as that sounds. I know how PING works now, but I'm still not quite sure how you would use a PONG, other than to reply to a PING.

Yay295 commented 7 years ago

I suppose if I were PING Yay295ed, I could PONG numberoverzero irc.github.com you (if I'm understanding it correctly), but I don't know why I would want to do that.

Actually...

If we were on different servers and you PING Yay295 myservered me, I would have to PONG numberoverzero yourserver you. I think.

numberoverzero commented 7 years ago

If we were on different servers and you PING Yay295 myservered me, I would have to PONG numberoverzero yourserver you. I think.

I believe this is correct, yes.

JOIN 0 does make you leave all channels, as silly as that sounds.

I decided to look up 3.2.1 to verify because this sounds so strange (even though I wrote that comment!) so for any future readers, in fact this is correct:

Note that this message accepts a special argument ("0"), which is a special request to leave all channels the user is currently a member of. The server will process this message as if the user had sent a PART command (See Section 3.2.2) for each channel he is a member of.

Yay295 commented 7 years ago

I tried pinging a different server using this library and Hexchat, but I just got a 401 ERR_NOSUCHNICK response in Hexchat, and nothing in Python, so even if that is how it's supposed to work it doesn't seem well supported.

numberoverzero commented 7 years ago

Thanks for your persistence, glad to see this change make it in! There are a few dangling items but since they're part of larger stories I think we can address them in another PR:

I'm going to hold off on a new PyPI release to batch up the other PRs and doc improvements. Thanks again 🚀