README: clarify what's being linked #1114
Open
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
It wasn't immediately clear to me that the link in question was bringing me to a *different* testing library's documentation. Clarify that.
dittrichlucas
approved these changes
Oct 31, 2021
dittrichlucas
approved these changes
Aug 30, 2023
dolmen
changed the title
dolmen
requested changes
Jun 2, 2025
| @@ -16,7 +16,7 @@ Features include: | |||
| Get started: | |||
|
|
|||
| * Install testify with [one line of code](#installation), or [update it with another](#staying-up-to-date) | |||
| * For an introduction to writing test code in Go, see https://go.dev/doc/code#Testing | |||
| * For an introduction to writing test code in Go using its default testing framework, see https://go.dev/doc/code#Testing | |||
There was a problem hiding this comment.
I don't think that the wording is that much better. Because in fact knowing the testing framework is requirement to be able to use Testify. So this is not about testing being the default but being the base framework.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Clarify that the link in question points to the default testing framework, not
testify.Changes
Add clause
using its default testing frameworkMotivation
It wasn't immediately clear to me that the link in question was bringing me to a different testing library's documentation.