summaryrefslogtreecommitdiff
path: root/spew/config.go
diff options
context:
space:
mode:
authorDave Collins <[email protected]>2013-03-03 12:23:56 -0600
committerDave Collins <[email protected]>2013-03-03 12:59:13 -0600
commit9dfc23886547f6515837b0d94c156252fcca83fc (patch)
tree926db96f954fb343a9a793dd0acaaa406ab9d38a /spew/config.go
parent6d6046a9de11932943e5ef05d72c0ee2f02f1797 (diff)
Cleanup documentation on new ContinueOnMethod code.
This commit expands on TShadwell's work attached to issue #8. It rounds out the documentation for the new option.
Diffstat (limited to 'spew/config.go')
-rw-r--r--spew/config.go16
1 files changed, 10 insertions, 6 deletions
diff --git a/spew/config.go b/spew/config.go
index ea521cc..406171a 100644
--- a/spew/config.go
+++ b/spew/config.go
@@ -63,11 +63,14 @@ type ConfigState struct {
// inside these interface methods.
DisablePointerMethods bool
- //ContinueOnMethod specifies whether recursion should stop once
- //a Stringer or an error interface is encountered.
+ // ContinueOnMethod specifies whether or not recursion should continue once
+ // a custom error or Stringer interface is invoked. The default, false,
+ // means it will print the results of invoking the custom error or Stringer
+ // interface and return immediately instead of continuing to recurse into
+ // the internals of the data type.
//
- //It defaults to false, meaning that it does not pretty-print
- //the internals of Stringers or errors.
+ // NOTE: This flag does not have any effect if method invocation is disabled
+ // via the DisableMethods or DisablePointerMethods options.
ContinueOnMethod bool
}
@@ -255,10 +258,11 @@ func (c *ConfigState) convertArgs(args []interface{}) (formatters []interface{})
// NewDefaultConfig returns a ConfigState with the following default settings.
//
-// Indent: " "
+// Indent: " "
// MaxDepth: 0
// DisableMethods: false
-// DisablePointerMethods: false
+// DisablePointerMethods: false
+// ContinueOnMethod: false
func NewDefaultConfig() *ConfigState {
return &ConfigState{Indent: " "}
}