Include troubleshooting section about rounding errors #984
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garris
requested changes
Feb 13, 2019
README.md
Outdated
| @@ -954,6 +954,10 @@ Sometimes bad permissions happen to good people. It's ok, this is a safe space. | |||
|
|
|||
| Be sure to use a config `id` in your config file. See https://github.com/garris/BackstopJS/issues/291 | |||
|
|
|||
| ### There's no visible difference between "Reference" and "Test" screenshots | |||
|
|
|||
| You might run into an issue where your reference and test screenshots look seemingly identical but on further inspection have a 1px difference in height or width. To fix this, make sure your viewport is the same as the one you have setup in your configuration. Then, check whether the element you target has a height or width that is a comma-separated value (i.e. 804.25px). If so, you might have run into a rounding error. Adjusting your viewport so the element's width is a natural number will help with this. | |||
There was a problem hiding this comment.
Hi, I am not sure this is clear -- the example you give is not comma separated. Where would a user check this value?
height or width that is a comma-separated value (i.e. 804.25px)
There was a problem hiding this comment.
Hey, I guess I was too much in my German mindset where we use commas instead of dots. I updated the description. Do you think it's useful now?
Also, sorry for taking so long on this, I was working on a different project in the meantime. Next answer won't take so long :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would have found it very beneficial if the readme would have included something about those weird rounding errors that sometimes pop up so I wrote a short section about that. :)