Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example for complex error parameters #1218

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ash211
Copy link
Contributor

@ash211 ash211 commented Jul 19, 2022

Fixes #1217

Before this PR

No example for complex error parameters. I didn't see it explicitly specified before (see linked issue).

After this PR

==COMMIT_MSG==
Add example for complex error parameters: a list<integer>
==COMMIT_MSG==

Possible downsides?

Slightly increases size of wire spec document

@ash211 ash211 requested a review from pkoenig10 July 19, 2022 03:47
@pkoenig10
Copy link
Member

I'm not convinced this makes the documentation meaningfully clearer. We already have an example for each of the keys listed here and we're not going to add an example for every JSON data type, so it's not clear what is sufficiently special about a list to include it here.

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.

Clarify the serialized wire format for complex error parameters
2 participants