search

logicomacorp / WaveSabre

Official WaveSabre repository
MIT License
245 stars 33 forks source link

Converter: Fix incorrect comment for automation de-dupe routine #71

Closed yupferris closed 3 years ago

yupferris commented 3 years ago

This may seem trivial/benign, but I'm trying to make sure all of our test refs are up-to-date (#63), and it's a bigger job than I'd like, so I'm hoping to grasp the existing code enough to just trust it and update the refs more or less automatically. This comment ended up throwing me for a loop more than I'd like to admit!

The comment now matches the current behavior, which should produce correct results. The previous description would turn this:

     v redundant point
   ._._.
_./     \._

Into this:

     v adjusted point; the point that used to be here is removed
     ._.
_.~~~   \._

Which is clearly wrong. Instead, we should (and do) get this:

       v adjusted point; the point that used to be here is removed
   .___.
_./     \._
yupferris commented 3 years ago

I'm just going to merge; I don't have a lot of time these days and it's harder to get in/out of projects lately, so I want to keep up momentum while my head's in this space.