Misleading error message when .roughly() assert fails

[kiprobinsonknack]

When using .roughly(), when a test (legitimately) fails, the error message is misleading. Here is an example:

const chai = require('chai');

const { expect } = chai;
chai.use(require('chai-roughly'));

describe('example test set', () => {
  it('example test', () => {
    const expected = { num1: 12.39197,   num2: 5, num3: 19 };
    const actual =   { num1: 12.3919725, num2: 5, num3: 17 };
    expect(actual).to.roughly(0.001).deep.equal(expected); // fails (which is correct)
  });

});

The issue isn't that the test fails. The issue is that the failure message looks like this:

      AssertionError: expected { num1: 12.3919725, num2: 5, num3: 17 } to roughly deeply equal { num1: 12.39197, num2: 5, num3: 19 }
      + expected - actual

       {
      -  "num1": 12.3919725
      +  "num1": 12.39197
         "num2": 5
      -  "num3": 17
      +  "num3": 19
       }

This makes it look like the different values for num1 are also part of the reason why it failed, but the only reason it failed is that the num3 values are not within range. If you edit the num3 values to match, the test no longer fails.