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

Adds common examples for the simpleion load/dump APIs. #294

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

cheqianh
Copy link
Contributor

@cheqianh cheqianh commented Nov 2, 2023

Some customers found that the lack of documentation makes them really hard to onboard Ion. While discussing and documenting a long-term solution, I'll use this PR to add common examples for the simpleion load/dump APIs first.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@rmarrowstone
Copy link
Contributor

This is a good start.

A couple other observations/suggestions:

  1. The main confusion I have as a user is load vs loads I would clarify that somewhere.
  2. To that end: we have a module pydoc. Consider enhancing that to aim users to the primary entry points.
  3. After the addition of the c-extension it looks like the bulk of the pydoc is now on the _python methods.
  4. Personally, I find the type mapping tables (on both loads and dumps) to be too much there and just sort of confusing. A possible suggestion would be to pull that out into the module doc in a single table that had both the Python -> Ion and Ion -> Python type mappings.

@cheqianh cheqianh merged commit 6e10df3 into amazon-ion:master Nov 7, 2023
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.

3 participants