docs: add testify %% escaping convention to AGENTS.md#316
Merged
Conversation
Testify assert functions only apply fmt.Sprintf when format args are passed (len(msgAndArgs) > 1). With a single message string, %% prints literally. This caused 6 incorrect test messages fixed in PR #314. Document the convention with correct/incorrect examples to prevent recurrence. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
Add a testing convention for testify
%%escaping to prevent the bugfixed in PR #314 from recurring.
Testify
assert.*functions only applyfmt.Sprintfto the message whenlen(msgAndArgs) > 1. With a single message string (no format args),%%prints literally as
%%instead of%. This caused 6 incorrect testmessages across
chain_test.goandchange_filter_test.go.The convention documents when to use
%vs%%with examples.