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

Documentation: Provide usage examples in non-trivial ways #3

Open
seanmay opened this issue Jul 7, 2018 · 0 comments
Open

Documentation: Provide usage examples in non-trivial ways #3

seanmay opened this issue Jul 7, 2018 · 0 comments
Milestone

Comments

@seanmay
Copy link
Owner

seanmay commented Jul 7, 2018

Rather than just writing examples that show JSON which completely matches the expected internal types of the closed system, also write types that show separate interfaces for the internal type, and the expected system input ("Is this data sufficient to pass to a constructor for my type?").

On top of that, show how if you receive superset god-objects, with all members nullable, you should validate against algebraic types which are the expected potential unions that could have been derived from that god object. "Is the input blob sufficient to make an A? Make an A. Is it sufficient to make a B? Make a B."

@seanmay seanmay added this to the 1.0 Release milestone Jul 7, 2018
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

No branches or pull requests

1 participant