docs: Document the slot module

[kamalmarhubi]

No description provided.

[kamalmarhubi]

@alexcrichton I'm super excited about this library and have been reading through. I found parts of Slot hard to grasp, particularly cancellation, and ended up documenting it. I'm doing the same with other parts as I read through. Let me know if you want other PRs!

[kamalmarhubi]

I also added a couple of TODOs that look like things that could make sense. Happy to actually do those if they do make sense.

[alexcrichton]

Thanks! This library is currently seriously under-documented, and I've got a huge amount of documentation I'd want to add. The implementation of Slot is massively tricky and isn't really currently intended for anyone to read but me, unfortunately. Once this starts getting further along I'll be sure to add them plus many more!

[kamalmarhubi]

Yeah I figured it might be in too early a state for PRs. FWIW, I'll continue adding docs in my doc branch as I get more understanding of how this fits together, and how to use it. Also some experiments in other branches, eg a basic http multiplexer and a threadpool-based executor for fs operations so far.

[kamalmarhubi]

Also consider this an offer to write some docs :-)

[alexcrichton]

Nice! We talked last night, but I'll try to prioritize soon to write docs for all this stuff as well, especially the particularly tricky parts.