Adds basic crate-level documentation #490
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #490 +/- ##
==========================================
- Coverage 89.60% 89.59% -0.01%
==========================================
Files 76 76
Lines 13888 13894 +6
==========================================
+ Hits 12444 12448 +4
- Misses 1444 1446 +2
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
🗺️ cargo doc pointed out some nits in this file and the next.
| fn from(value: Vec<u8>) -> Self { | ||
| Value::Blob(value) | ||
| } | ||
| } |
There was a problem hiding this comment.
🗺️ While writing the doc tests, I realized we didn't have an Into<Value> impl for the blob-ish Rust types.
| #[doc(inline)] | ||
| pub use data_source::IonDataSource; | ||
| #[doc(inline)] | ||
| pub use raw_symbol_token::RawSymbolToken; | ||
| #[doc(inline)] |
There was a problem hiding this comment.
🗺️ #[doc(inline)] prevents these from showing up in a big "Re-exports" list in the docs. We'll probably add this to more types before 1.0.
|
|
||
| use element::owned::Element; |
There was a problem hiding this comment.
clippy suggests this unused import
There was a problem hiding this comment.
Clippy says its unused, but it's actually needed for all of the [Element] type references in the doc comments. I've added an annotation to suppress the clippy warning.
| //! let mut reader = ReaderBuilder::default().build(ion_file)?; | ||
| //! // A simple pretty-printer | ||
| //! for element in reader.elements() { | ||
| //! println!("{}", element?) |
There was a problem hiding this comment.
Should we add a sample file content and output for this example?
There was a problem hiding this comment.
It does stand out as the only example without an assert_eq!, but I figured seeing how to access the elements in a file would be enough for folks to use the other tests' examples. I'm going to leave this as-is for the moment to get v0.16.0 out, but I'm open to changing it in the future.
Provides examples for creating, reading, and writing
Elements.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.