From 13fc9b8d2f9442ecc1754b1738a97cf0a0754e92 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Sat, 19 Jan 2013 19:00:25 -0600 Subject: Move SpewState methods to ConfigState. Rather than stuffing a ConfigState instance into a separate SpewState, just add the functionality directly to the ConfigState. This provides simpler syntax for the consumer. One side effect of this change is that, unlike a zero value SpewState, a zero value ConfigState doesn't provide default values which means the Indent field is set to provide no indentation. The consumer is now expected to set the indent to their desired value when declaring an instance of ConfigState. Alternatively, the consumer can call a new function, NewDefaultConfig, which returns a ConfigState with default values, including a default indentation of a single space. For example, to change the indent to a tab, the previous syntax was: ss := new(spew.SpewState) // or var ss spew.SpewState scs := ss.Config() scs.Indent = "\t" scs.Dump(whatever) The new syntax is simply: scs := spew.ConfigState{Indent: "\t"} scs.Dump(whatever) --- spew/doc.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'spew/doc.go') diff --git a/spew/doc.go b/spew/doc.go index 84cc1b3..5b0725c 100644 --- a/spew/doc.go +++ b/spew/doc.go @@ -65,10 +65,9 @@ Configuration of spew is handled by fields in the ConfigState type. For convenience, all of the top-level functions use a global state available via the spew.Config global. -It is also possible to create a SpewState instance which provides a unique -ConfigState accessible via the Config method. The methods of SpewState are +It is also possible to create a ConfigState instance that provides methods equivalent to the top-level functions. This allows concurrent configuration -options. See the SpewState documentation for more details. +options. See the ConfigState documentation for more details. The following configuration options are available: * MaxDepth -- cgit v1.2.3