docs(require): correct example usage to use assert.CollectT (require.CollectT does not exist) #1821
+29
−6
Conversation
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
Author
|
Oops. I didn't know that it was in generated file. |
Update replace funcmap to replace "assert." with "require." while preserving "*assert.CollectT" references. This prevents unintended replacement of pointer references to CollectT, ensuring correct code generation. Signed-off-by: a2not <[email protected]>
a2not
force-pushed
the
fix-doc-require_collect-not-exist
branch
from
1e61e54 to
a39aa2d
Compare
Refactored the Replace function in _codegen/main.go to support preserving multiple identifiers, not just "*assert.CollectT". Updated usage in require/require.go to reflect new placeholder format. This improves extensibility and maintainability for future identifier additions. Signed-off-by: a2not <[email protected]>
Update placeholder generation to use uppercase and replace dots with underscores, ensuring consistency and preventing accidental replacement of preserved identifiers. Also update documentation examples in require.go to use correct types. Signed-off-by: a2not <[email protected]>
a2not
commented
Nov 8, 2025
Comment on lines
301
to
303
| identifiersToBePreserved := []string{ | ||
| "*assert.CollectT", | ||
| } |
Author
There was a problem hiding this comment.
This might be over-generalizing things, since so far we only want to preserve one keyword.
Let me know if I need to simplify this so that it only cares about assert.CollectT like a39aa2d#diff-4b4cb0af6b5935c8adcb9f00b426367349e989296edf13eee95831c4bb93c831R299-R310.
Remove pointer from "assert.CollectT" in identifiersToBePreserved to ensure correct string replacement behavior in testFunc.Replace. This prevents unintended placeholder substitution for pointer types. Signed-off-by: a2not <[email protected]>
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.
Summary
Update documentation comments in require.go to use assert.CollectT instead of require.CollectT in EventuallyWithT and EventuallyWithTf examples. This clarifies the intended usage and prevents confusion for users.
Changes
Motivation
The documentation was confusing since it uses non-existent type.
Related issues