Documentation Question (Maybe OT)

[Daniel Becroft]

Hey all,

I am currently in the process of creating a small data structures
package, and doing the API documentation as a I go.

My question is, as programmers, what information would you guys
like/need from the documentation regarding such a package? I know the
obvious stuff: class names, method names/signatures, etc, but would
something like efficiency information (big-Oh notation) be useful?

Thanks,

[Buch]

Post by Daniel Becroft
My question is, as programmers, what information would you guys
like/need from the documentation regarding such a package? I know the
obvious stuff: class names, method names/signatures, etc, but would
something like efficiency information (big-Oh notation) be useful?

Yes.
Real world examples of how to use also. I found them most valuable, since it
allows me fast start.