doc.go

 1// Copyright 2013 Google Inc.  All rights reserved.
 2//
 3// Licensed under the Apache License, Version 2.0 (the "License");
 4// you may not use this file except in compliance with the License.
 5// You may obtain a copy of the License at
 6//
 7//     http://www.apache.org/licenses/LICENSE-2.0
 8//
 9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// Package pretty pretty-prints Go structures.
16//
17// This package uses reflection to examine a Go value and can
18// print out in a nice, aligned fashion.  It supports three
19// modes (normal, compact, and extended) for advanced use.
20//
21// See the Reflect and Print examples for what the output looks like.
22package pretty
23
24// TODO:
25//   - Catch cycles