Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for the Error function in assert or require package #1675

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+16 −32
Open

Update documentation for the Error function in assert or require package #1675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2eca2b1
update documentation for the Error function in assert or require pack…
architagr Nov 2, 2024
d27af4e
update documentation for auto require package
architagr Nov 2, 2024
fc69fea
Merge branch 'master' into doc-update-for-error-fn
architagr Nov 17, 2024
0c935ad
Merge branch 'master' into doc-update-for-error-fn
architagr Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions assert/assertion_format.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 4 additions & 8 deletions assert/assertion_forward.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions assert/assertions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1591,10 +1591,8 @@ func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool {

// Error asserts that a function returned an error (i.e. not `nil`).
//
// actualObj, err := SomeFunction()
// if assert.Error(t, err) {
// assert.Equal(t, expectedError, err)
// }
// actualObj, err := SomeFunction()
// assert.Error(t, err)
Comment on lines +1594 to +1595
Copy link
Contributor

@alexandear alexandear Dec 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe better would be the following:

Suggested change
// actualObj, err := SomeFunction()
// assert.Error(t, err)
// actualObj, err := SomeFunction()
// if assert.Error(t, err) {
// assert.Equal(t, expectedObj, actualObj)
// }

In that case, we don't hide that Equals returns boolean.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not good practice IMO, a good test will check the returned actualObj even if the returned error is non-nil.

func Error(t TestingT, err error, msgAndArgs ...interface{}) bool {
if err == nil {
if h, ok := t.(tHelper); ok {
Expand Down
12 changes: 4 additions & 8 deletions require/require.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 4 additions & 8 deletions require/require_forward.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading