search

DanielStutzbach / blist

A list-like type with better asymptotic performance and similar performance on small lists
Other
313 stars 35 forks source link

Write documentation for all types and methods #21

Closed DanielStutzbach closed 14 years ago

fmark commented 14 years ago

It would be great if the documentation for methods could include their asymptotic run-time.

DanielStutzbach commented 14 years ago

I've written documentation for blist, sortedset, sortedlist, weaksortedset, and weaksortedlist. Still to-do: sorteddict and btuple.

http://stutzbachenterprises.com/blist-doc/

fmark commented 14 years ago

This is fantastic, thank you! Especially for someone relatively new to python and thus not familiar with the idomatic expectations of how a class would behave (for example, the use of "del" to remove elements).

DanielStutzbach commented 14 years ago

I'm glad it helps! Let me know if you spot any typos or have any questions. :-)

fmark commented 14 years ago

Just returning to my blist using code, and wanted to let you know how happy I am about having good docs :) Especially with the asymptotic behaviour.