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

Add documentation for public types and modules #587

Closed
popematt opened this issue Jun 30, 2023 · 0 comments · Fixed by #605
Closed

Add documentation for public types and modules #587

popematt opened this issue Jun 30, 2023 · 0 comments · Fixed by #605
Milestone

Comments

@popematt
Copy link
Contributor

Documentation is missing from these types/modules (and possibly more). Even a one sentence description would be helpful.

  • ion_rs::types::Int – even something as minimal as "An in memory representation of an Ion int"
  • ion_rs::types::SymbolId
  • ion_rs::element::builders
  • ion_rs::result and all of its child modules
  • ion_rs::element::reader::OwnedElementIterator

There are also more modules and types that are missing documentation, but I tried to focus on the ones that might remain public for the 1.0.0 release.

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 a pull request may close this issue.

1 participant