go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/testing/assert/structuraldiff/doc.go (about)

     1  // Copyright 2024 The LUCI Authors.
     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 structuraldiff provides best-effort prettyprinting and diffing of
    16  // pretty-printed values.
    17  //
    18  // The output of any method in this package is not remotely stable. Use at your
    19  // own risk.
    20  //
    21  // As a quick word of caution, both DebugDump and DebugEqual are intentionally
    22  // abstraction-breaking and will NOT ignore unexported fields. Other packages
    23  // like go-cmp will ignore unexported fields and will make you pass in an option
    24  // to prove that you own the struct in question and can look at its fields.
    25  //
    26  // We don't do that. You can always see everything.
    27  package structuraldiff