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

Document best practices for data serialization #7985

Closed
4 tasks
Tracked by #21429 ...
robert-zaremba opened this issue Nov 20, 2020 · 0 comments · Fixed by #21992
Closed
4 tasks
Tracked by #21429 ...

Document best practices for data serialization #7985

robert-zaremba opened this issue Nov 20, 2020 · 0 comments · Fixed by #21992
Assignees
Labels
T: Dev UX UX for SDK developers (i.e. how to call our code) T:Docs Changes and features related to documentation.

Comments

@robert-zaremba
Copy link
Collaborator

Summary

Data serialization is at the core of every module. We need to process user input, serialize data in a storage and send the responses. We don't clearly document how we should do that.

Problem Definition

Dealing with data serialization can be problematic. We have bunch of functions in codec or Marshaler interface. We should document with examples what one have to do properly serialize data structures, interfaces and do interface implementation registration. Moreover we should document the best practice to manage a codec.Marshaler and avoid copying / recreating it through the simapp.

Proposal

Documentation + best practice document.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@robert-zaremba robert-zaremba added T:Docs Changes and features related to documentation. T: Dev UX UX for SDK developers (i.e. how to call our code) labels Nov 20, 2020
@tac0turtle tac0turtle mentioned this issue Aug 30, 2022
18 tasks
@tac0turtle tac0turtle self-assigned this Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: Dev UX UX for SDK developers (i.e. how to call our code) T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants