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

Document state of server module #31

Merged
merged 1 commit into from Jul 19, 2015
Merged

Document state of server module #31

merged 1 commit into from Jul 19, 2015

Conversation

edunham
Copy link
Contributor

@edunham edunham commented Jul 19, 2015

I was looking up how to do basic IRC stuff in Rust and found my way to http://aatxe.github.io/irc/irc/server/index.html and spent an embarrassing number of minutes trying to figure out why the docs weren't displaying. Turns out there weren't supposed to be any docs. This change will prevent such confusion in anyone else who finds these docs the way I did.

@aatxe
Copy link
Owner

aatxe commented Jul 19, 2015

Good point. Sorry that this didn't already exist! Thanks!

aatxe added a commit that referenced this pull request Jul 19, 2015
Document state of server module
@aatxe aatxe merged commit c6d7dff into aatxe:master Jul 19, 2015
@edunham
Copy link
Contributor Author

edunham commented Jul 19, 2015

Thanks, and thanks also for the quick reply! I suspect that if you outline the plan you had in mind for the server module and link to that document from #22, others might want to help out with writing it :)

Of course, I also completely understand if the overhead of triaging and reviewing a bunch of contributions would be greater than simply writing the first version yourself when you get the time.

@aatxe
Copy link
Owner

aatxe commented Jul 19, 2015

The reality is that I've mostly been putting off working on it because I can't decide on a scope, and also in much smaller part because of the mess that is Commands (see #16). I added a comment to #22 to reflect that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants