README.md

Documentation: github.com/google/go-cmp

     1# Package for equality of Go values
     2
     3[![GoDev](https://img.shields.io/static/v1?label=godev&message=reference&color=00add8)][godev]
     4[![Build Status](https://github.com/google/go-cmp/actions/workflows/test.yml/badge.svg?branch=master)][actions]
     5
     6This package is intended to be a more powerful and safer alternative to
     7`reflect.DeepEqual` for comparing whether two values are semantically equal.
     8
     9The primary features of `cmp` are:
    10
    11* When the default behavior of equality does not suit the needs of the test,
    12  custom equality functions can override the equality operation.
    13  For example, an equality function may report floats as equal so long as they
    14  are within some tolerance of each other.
    15
    16* Types that have an `Equal` method may use that method to determine equality.
    17  This allows package authors to determine the equality operation for the types
    18  that they define.
    19
    20* If no custom equality functions are used and no `Equal` method is defined,
    21  equality is determined by recursively comparing the primitive kinds on both
    22  values, much like `reflect.DeepEqual`. Unlike `reflect.DeepEqual`, unexported
    23  fields are not compared by default; they result in panics unless suppressed
    24  by using an `Ignore` option (see `cmpopts.IgnoreUnexported`) or explicitly
    25  compared using the `AllowUnexported` option.
    26
    27See the [documentation][godev] for more information.
    28
    29This is not an official Google product.
    30
    31[godev]: https://pkg.go.dev/github.com/google/go-cmp/cmp
    32[actions]: https://github.com/google/go-cmp/actions
    33
    34## Install
    35
    36```
    37go get -u github.com/google/go-cmp/cmp
    38```
    39
    40## License
    41
    42BSD - See [LICENSE][license] file
    43
    44[license]: https://github.com/google/go-cmp/blob/master/LICENSE
View as plain text