BlueRaja / High-Speed-Priority-Queue-for-C-Sharp

A C# priority queue optimized for pathfinding applications
MIT License
1.15k stars 169 forks source link

Documentation contradicts examples #47

Closed WazWaz closed 4 years ago

WazWaz commented 4 years ago

It appears that the documentation of FastPriorityQueueNode.Priority is from some previous version as it talks about setting the Priority in the constructor of the node, and yet FastPriorityQueue.Enqueue now has the priority as a parameter, so it seems wrong for the node to be setting anything, and sure enough, the example doesn't.

Is it the example or the Priority documentation that is misleading?

BlueRaja commented 4 years ago

Yep, looks like I missed a documentation update. Good catch! I'll fix this in the next minor release (which may be a while..)

BlueRaja commented 4 years ago

Fixed in v5.0.0