Rename DisableCodeHunks option to CodeHunks about gobrake HOT 1 CLOSED

Unfortunately, we will have to stick to the current API because changing it will break user code.

Golang doesn't support default struct values and the way we currently recommend initializing a config is like this:

opt := &gobrake.NotifierOptions{
	DisableCodeHunks: true,
}

If we make the renaming, then we no longer will be collecting code hunks by default. Users will have to enable the option explicitly in the config to keep using code hunks:

opt := &gobrake.NotifierOptions{
	CodeHunks: true,
}

However, we want to collect that by default. So the proper solution is to recommend initializing the config via our constructor method instead. Something like this:

type NotifierOptions struct {
	CodeHunks bool
}

func NewNotifierOptions() *NotifierOptions {
	return &NotifierOptions{
		CodeHunks: true,
	}
}

// ------

opt := gobrake.NewNotifierOptions()

Alternatively, we can make it a reference to bool:

type NotifierOptions struct {
	CodeHunks *bool
}

// ---

f := &false
opt := NotifierOptions{
	CodeHunks: &f,
}

But that looks ugly as an API.

from gobrake.