heap-js icon indicating copy to clipboard operation
heap-js copied to clipboard

Documentation for `limit`

Open therji-motif opened this issue 1 year ago • 1 comments

The documentation for limit is sparse, and I for some reason thought it would enforce the heap to keep the top N values. Instead, I'm not actually quite sure what it's doing, or what some practical purposes are for it? Some clarity here would be great, as sometimes my test results with limit returned "correctly" (but it was purely by chance).

therji-motif avatar Jan 19 '24 22:01 therji-motif

Thanks for your feedback @therji-motif . I will review the implementation and update the documentation accordingly. My apologies for the inaccuracy.

ignlg avatar Feb 24 '24 14:02 ignlg