docs: restore dropped dbg macro name in bad_error_messages comment#6059
Open
prql-bot wants to merge 2 commits into
Open
docs: restore dropped dbg macro name in bad_error_messages comment#6059prql-bot wants to merge 2 commits into
dbg macro name in bad_error_messages comment#6059prql-bot wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
prql-bot
changed the title
dbg! macro name in bad_error_messages commentdbg macro name in bad_error_messages comment
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.
The contributor guidance at the top of
bad_error_messages.rsreads "Add `` macros to the code to see what's going on" — the inline-code span is empty. The macro name was dropped somewhere along the way; the comment originally read "Adddbgmacros" (see the pre-`prqlc` history in `7c510444`, before the `prql-compiler` → `prqlc` merge). This restores it.Kept as
dbg(no!) deliberately: theno-dbgpre-commit hook (.pre-commit-config.yaml) is apygrepover all Rust files for the literaldbg!, so writing the bang — even inside a doc comment — trips the hook. The original text dodged this the same way.Surfaced by the nightly code-quality survey.
No test: this is a comment-only change with no behavior to exercise.