Deny missing documentation and flesh out existing docs #689
Comments
|
Is it possible to add this for sub-crates to start? E.g. not at the top-level |
|
Yup, it is, or you can |
kylebarron
added a commit
that referenced
this issue
Aug 13, 2024
Includes: - A breaking cahnge to `Table::from_arrow_and_geometry` to make the argument order the same as `Table::try_new` - Removal of a leftover `dbg!` statement in [src/array/coord/separated/array.rs](0ab9dc0#diff-05c34ee401b527590650de1809d1edcc54957ce8a5c47128371bc83729ba2392) - Moved two single-file `mod-name/mod.rs` modules up a level (`table.rs` and `chunked_array.rs`) - Some README tweaks, including adding badges - `#![deny(missing_docs)]` to `lib.rs`, and then `#![allow(missing_docs)]` on the "deep" modules (e.g. `algorithm`, `array`) - Docs to the rest of the modules, with examples almost always NB I've updated #689 with a checklist to track progress on the "deep" modules --------- Co-authored-by: Kyle Barron <[email protected]>
kylebarron
pushed a commit
that referenced
this issue
Aug 23, 2024
If it's ok, I'd be stoked to get a v0.3.0 release of **geoarrow** — some of my **stac-geoparquet** is getting close to being release-able. Here's a checklist of things that have been mentioned as part of a v0.3 (including #628 (comment) and https://github.com/geoarrow/geoarrow-rs/milestone/3): - #660 is done ✅ - Some (but not all) of the doc updates are done in #696, and I've got a tracking issue for the rest in #689 - "Broader support for 3d geometries" isn't done as far as I know, but I haven't really been touching that at all yet - #539 is a Python thing, not a Rust crate thing As a part of this release PR I've updated our deps when possible (`sqlx` will require code change to support an update so I haven't done that one).
kylebarron
added a commit
that referenced
this issue
Aug 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
By adding
#![deny(missing_docs)]to the Rust crate, we can help ensure that all public items are documented. We should also add examples, when appropriate, to existing docs.Checklist
lib: Add some (but not all) docs for the Rust crate #696trait_,error,datatypes,table,chuncked_array,indexed: Add some (but not all) docs for the Rust crate #696#![deny(missing_docs)]to top level and# to "deep" mods: Add some (but not all) docs for the Rust crate #696scalariogeo_traitsarrayalgorithmThe text was updated successfully, but these errors were encountered: