Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Docs] Document SDK marshaller #592

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.

Sign up for GitHub

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

Jump to bottom
Open
roxblnfk opened this issue Apr 9, 2025 · 4 comments
Open

[Docs] Document SDK marshaller #592

roxblnfk opened this issue Apr 9, 2025 · 4 comments
Labels
Documentation Improvements or additions to documentation

Comments

@roxblnfk
Copy link
Collaborator

roxblnfk commented Apr 9, 2025

Documentation for the marshaller is completely missing. New users have no way to learn how to serialize data objects, typed lists, and more.
It's necessary to explain attributes like Marshal, MarshalArray, types, and so on.
@roxblnfk roxblnfk added the Documentation Improvements or additions to documentation label Apr 9, 2025
@KorDum
Copy link

KorDum commented Apr 14, 2025

Apparently, it will be necessary to modify it a bit for static analyzers:
#595
#596

@mtorromeo
Copy link

This is a fundamental concept that needs documenting.

Is there at least an example that I can take a look at?

@roxblnfk
Copy link
Collaborator Author

Is there at least an example that I can take a look at?

https://github.com/temporalio/samples-php/blob/e291d400cec4fa819d428d84f0311dcb0fc3c6bb/app/src/Updates/Zonk/Table.php#L14-L20

https://github.com/temporalio/samples-php/blob/e291d400cec4fa819d428d84f0311dcb0fc3c6bb/app/src/Updates/Zonk/Dice.php#L13-L16

@mtorromeo
Copy link

For my use case I ended up using a custom DataConverter, which is also not documented for PHP.

The difference between DataConverters and marshalling is also not clear, which is a byproduct of the lacking documentation on these topics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mtorromeo @KorDum @roxblnfk