SeattleTestbed / repy_v1

Seattle Testbed's original Repy version 1 sandbox
MIT License
1 stars 4 forks source link

API Documentation Clarity/Symmetry #135

Open awwad opened 8 years ago

awwad commented 8 years ago

See example of recvmess (https://seattle.poly.edu/wiki/RepyApi#recvmesslocaliplocalportfunction) and waitforconn (https://seattle.poly.edu/wiki/RepyApi#waitforconnlocaliplocalportfunction), which are largely UDP vs TCP versions of each other.

Documentation in the API (https://seattle.poly.edu/wiki/RepyApi) there is not very symmetrical - that is, things are often phrased in a way that makes it hard to pick out possible differences. For example, waitforconn's return documentation reads: "A handle to the listener. This can be used to stop listening ", while recvmess's return documentation reads: "The commhandle for this callback. ". Are those equivalent? Or not? The documentation is like that throughout for those two functions.