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

Unify rawPayload message docs #1551

Merged
merged 1 commit into from
Dec 6, 2024
Merged

Conversation

svix-jplatte
Copy link
Member

Motivation

In previous PRs for https://github.com/svix/monorepo-private/issues/9470, some review comments were made for better docs. I also just failed and used different ways of saying the same thing in different places. This all made for pointlessly diverging docs between the different languages.

Solution

Use the same basic formulation everywhere: "pre-serialized payload", same description of the "as-is" nature of raw payloads, same description of the content-type parameter. A number of language-specific docs remain to cover differences in how these functions work (e.g. for optional content-type, Java has two overloads of one function, Rust has a builder-style method, most other languages use an optional parameter).

@svix-jplatte svix-jplatte marked this pull request as ready for review December 6, 2024 12:57
@svix-jplatte svix-jplatte requested a review from a team as a code owner December 6, 2024 12:57
@svix-jplatte svix-jplatte merged commit 6c9b932 into main Dec 6, 2024
11 checks passed
@svix-jplatte svix-jplatte deleted the jplatte/message-in-raw-docs branch December 6, 2024 14:20
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