Fix typos in "abs. vs rel. error" doc code snippet - #175
Open
generalmimon wants to merge 1 commit into
Open
Conversation
I noticed that the same code example is in the file `test/check_lua_calc_error.lua`. I diffed the two versions and found that `test/check_lua_calc_error.lua` is correct, but the version in the documentation contains several typos: * `-- prints: 3` comment instead of `-- prints: 32` (I verified locally that running the test as `lua test/check_lua_calc_error.lua` prints `32.0` to the console) * missing `expected` arguments in all `assertAlmostEquals()` calls This commit fixes these issues, effectively unifying the two versions in terms of executable code (i.e. not comments). `test/check_lua_calc_error.lua` has fewer comments than the version in the documentation, but I ignored that. Perhaps it might be nice if `test/check_lua_calc_error.lua` had these comments too, but that's a matter of style, not correctness.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 noticed that the same code example is in the file
test/check_lua_calc_error.lua. I diffed the two versions and found thattest/check_lua_calc_error.luais correct, but the version in the documentation (https://luaunit.readthedocs.io/en/luaunit_v3_5/4_reference_doc.html#assertNotAlmostEquals) contains several typos:-- prints: 3comment instead of-- prints: 32(I verified locally that running the test aslua test/check_lua_calc_error.luaprints32.0to the console)expectedarguments in allassertAlmostEquals()callsThis PR fixes these issues, effectively unifying the two versions in terms of executable code (i.e. not comments).
test/check_lua_calc_error.luahas fewer comments than the version in the documentation, but I ignored that. Perhaps it might be nice iftest/check_lua_calc_error.luahad these comments too, but that's a matter of style, not correctness.