Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Fix the stack trace of check-expect forms - #228

Merged
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack
Nov 9, 2024
Merged

Fix the stack trace of check-expect forms#228
shhyou merged 6 commits into
racket:masterfrom
shhyou:check-form-stack

Conversation

@shhyou

Copy link
Copy Markdown
Collaborator

In #lang SLs, check-expect and similar forms are not annotated by errortrace.
This PR adds the errortrace:annotate syntax property to request for annotation.

Before:

#lang htdp/isl+
;; error at test-engine/racket-tests.rkt:XXX:XX
(check-expect 0 zero?)
;; check failure at lang/private/teachprims.rkt:XXX:XX
(check-expect zero? 0)

After: error at line 3, column 0 and line 5, column 0.


In addition to stack trace fixes, this PR refines and fixes somes check-form error messages:

  • check-random and check-expect should NOT have identical error messages.
  • Have check-expect messages refer to "the second argument" like other check-forms.
  • Format the third argument of check-within with ~s instead of ~a for otherwise strings like "NNN.mm" would be printed like numbers (i.e. just NNN.mm).

When reporting "not given an inexact number" in check-within, the given
has to be formatted with ~s since it could have been a string:
(check-within (sqrt 2) 3/2 "0.1")
(define (do-check-expect test expected src)
(error-check (lambda (v) (if (number? v) (exact? v) #t))
expected INEXACT-NUMBERS-FMT #t)
expected INEXACT-NUMBERS-FMT #t (list expected expected))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why expected is listed twice. This feels wrong.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the error message to:

check-expect: cannot compare inexact numbers, but the second argument is ~a. Try (check-within test ~a error-range).

Where the ", but the second argument is ~a" part is new.
So there are two ~a referring to expected now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you made sure that this change still works with the stepper?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup! This PR does not change the expansion but only attaches an extra syntax property.

@mfelleisen

Copy link
Copy Markdown
Contributor

Thanks for getting this started. I don't have time to review the changes inside the file yet but three of them raise questions already.

@mfelleisen

Copy link
Copy Markdown
Contributor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Can you do me a favor and check in Guillaume's paper whether "advice on how to fix things should go into error messages"? My recollection is that we should not do so unless obvious. I consider the suggestion in the modified inexact error message non-obvious.

Sort of -- Guillaume Marceau (et al.) say

  • Error messages should not propose solutions.

but also say that

The second warns against proposing corrections to syntax errors.

which is not directly targeting this error message. The suggestion in the message has been there since 2010, do you want to remove it?

@mfelleisen

mfelleisen commented Oct 25, 2024 via email

Copy link
Copy Markdown
Contributor

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Tests added to module-lang-test.rkt in racket/drracket#689.

@mikesperber

Copy link
Copy Markdown
Member

@rfindler and I had a conversation about this issue at ICFP - Robby, could you look at this?

@shhyou

Copy link
Copy Markdown
CollaboratorAuthor

Is this ready to be merged?

@rfindler

Copy link
Copy Markdown
Member

I'm sorry, I've lost track of this conversation. I don't see any issues from a look at the diff, but if there is something specific I should be remembering, could you remind me @mikesperber ?

@shhyou
shhyou merged commit 3eab980 into racket:masterNov 9, 2024
@shhyou
shhyou deleted the check-form-stack branch November 9, 2024 15:58
shhyou added a commit to racket/drracket that referenced this pull request Nov 11, 2024
 (#689)
* Add some tests for racket/htdp#228, racket/htdp#229, and racket/htdp#230 to
`tests/drracket/module-lang-test`.
+ Tests of racket/htdp#229 should first save the buffer to disk before running
+ Some racket/htdp#229 tests are ported from htdp-test:intm-lam.rktl
* Update `tests/drracket/language-test` to match racket/htdp#229.
* Manually check for empty stderr in tests/drracket/module-lang-test
Somehow `-e`/`--check-stderr` does not work with `tests/drracket/module-lang-test`
(perhaps due to using `test-log` + `exit 0` in `fire-up-drracket-and-run-tests`?)
* Test utils: sleep for 0.1s after printing error msg
In tests/drracket/module-lang-test, stderr goes through a pipe to be
checked for the absence of error messages. Therefore, sleep for 0.1s
before existing to let the background thread pipe the messages to terminal.
shhyou added a commit to shhyou/htdp that referenced this pull request Dec 27, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@shhyou@mfelleisen@mikesperber@rfindler