google/go-cmp

add examples for AllowUnexported and IgnoreUnexported

Open

#130 opened on Mar 4, 2019

View on GitHub
 (16 comments) (33 reactions) (0 assignees)Go (4,635 stars) (223 forks)user submission
help wanted

Description

Reading the docs and attempting simple implementations, I'm still not sure how to use these, since I keep getting panics. I'm going to search Github to see people using these successfully to figure out what I am missing.

Contributor guide

Tech stack
go
Domain
documentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Go knowledgefamiliarity with go cmp
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Look at existing test files (e.g., `cmp test.go`) and documentation files in the repository for examples of `AllowUnexported` and `IgnoreUnexported`. Check the issue comments for any maintainer guidance on preferred format. The issue requests adding clear examples to help users understand how to use these options without panics.