require.NoError does not work for given example

[MaerF0x0]

viewing https://godoc.org/github.com/stretchr/testify/require#NoError

gives the example

actualObj, err := SomeFunction()
  if assert.NoError(err) {
	   assert.Equal(t, expectedObj, actualObj)
  }

but require.NoError does not return a value . (also the example shows assert, though it should be about require)

IMO require.NoError should return a bool to match assert.NoError

let me know if you want a PR to fix.

[temoto]

@MaerF0x0 basically require.X = if !assert.X(...) { t.FailNow() } which ends test. It can't possibly return anything. I was confused about async documentation at first. You can easily tell it's just an unfortunate implication of require code being fully generated from assert code, including comments.

[beono]

This confuses a bit, 'till you understand that the whole file is copied from assert package.
It would be nice to fix comments somehow.

[xordspar0]

Is there currently a way to change comments in the generated require package?

[beono]

Is there currently a way to change comments in the generated require package?

As I understand the only way to change this is to modify the template:
https://github.com/stretchr/testify/edit/master/require/require.go.tmpl

+ // {{.DocInfo.Name}} is an autogenerated wrapper over assert.{{.DocInfo.Name}}
+ // The signature and examples may not match:
+ //
  {{.Comment}}
  func {{.DocInfo.Name}}(t TestingT, {{.Params}}) {
  	if h, ok := t.(tHelper); ok { h.Helper() }
  	if assert.{{.DocInfo.Name}}(t, {{.ForwardedParams}}) { return }
  	t.FailNow()
  }

Then it will produce:

// Error is an autogenerated wrapper over assert.Error.
// The signature and examples may not match:
//
// 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)
//   }
func Error(t TestingT, err error, msgAndArgs ...interface{}) {
	if h, ok := t.(tHelper); ok {
		h.Helper()
	}
	if assert.Error(t, err, msgAndArgs...) {
		return
	}
	t.FailNow()
}

[xordspar0]

What if the template didn't include the original comment, but instead had the part about it being a wrapper followed by a link to the original in the assert package? I'm not sure if that's more or less user friendly.

[beono]

Well, I guess a link in comments is not a convenient way to read documentation in some cases.

[temoto]

Please don't make linky docs.