Skip to content

added docs on protorequire.ProtoEqual in testing.md#10255

Merged
fretz12 merged 2 commits into
temporalio:mainfrom
fretz12:fredtzeng/proto-equals-readme
May 14, 2026
Merged

added docs on protorequire.ProtoEqual in testing.md#10255
fretz12 merged 2 commits into
temporalio:mainfrom
fretz12:fredtzeng/proto-equals-readme

Conversation

@fretz12
Copy link
Copy Markdown
Contributor

@fretz12 fretz12 commented May 13, 2026

What changed?

Added a short protorequire package subsection to docs/development/testing.md documenting protorequire.ProtoEqual and the new protorequire.IgnoreFields option, with a minimal usage example.

Why?

Follow-up to PR #9937. Without a doc entry, the new IgnoreFields helper is undiscoverable and contributors will keep reaching for the verbose cmp.Diff pattern.

How did you test it?

  • built
  • run locally and tested manually
  • covered by existing tests
  • added new unit test(s)
  • added new functional test(s)

@fretz12 fretz12 requested a review from stephanos May 13, 2026 23:37
@fretz12 fretz12 requested review from a team as code owners May 13, 2026 23:37
),
)
```

Copy link
Copy Markdown
Contributor

@stephanos stephanos May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we also add sth like "prefer a single ProtoEqual over field-by-field" as general guidance?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@fretz12 fretz12 merged commit daa9bcc into temporalio:main May 14, 2026
47 checks passed
@fretz12 fretz12 deleted the fredtzeng/proto-equals-readme branch May 14, 2026 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants