Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Help: improve Buffer:alloc bufnum arg description #3219
Is it documented anywhere exactly how buffer and bus numbers are allocated? The last sentence is not really clear to me (but I can't work on an alternative just now).
Part of the problem is that we have a bias toward documenting classes and methods, and against documenting concepts and usage patterns. The impulse is to fix this issue by updating method documentation, without explaining the underlying concepts... the bias at work.
I'm on mobile now, maybe later I'll play with it.
Hmm, I read that as highly discouraged, and unnecessary... but a comma would make that clearer. English is ambiguous here.
How about: Under normal usage this argument should be left as nil. Supplying a number bypasses the server's buffer allocator, which can lead to conflicts. See discussion of the allocator scheme here for more info.
I think this is OK for now. personally, when I read "which can lead to conflicts," I would really like to know where I can go to learn more. Especially when the top of the file just says to "see .alloc". I guess there should be a file/paragraph somewhere explaining allocators, it sounds like there isn't one currently.