Document finished features

CathalMullan commented 3 weeks ago

Both internal and public API needs documentation.

cargo watch --notify --shell "cargo doc --document-private-items"

EDIT: Doctest support is missing from nextest/llvm-cov, which is annoying for coverage metrics.

EDIT 2: Suprised there isn't a GHA to upload docs to pages, and comment a link on the PR.

Guess this PR is going to devolve into GHA shenanigans.

EDIT 3: Pages doesn't support sub-paths. Need to wait until the 'preview' feature releases: https://github.com/actions/deploy-pages

We can add a docs preview to the main branch, which will still be useful for pre-release checks.

EDIT 4: Noticed some inconsistencies around our error messages.

EDIT 5: Leaving the main, crate level documentation to a later date.

codspeed-hq[bot] commented 3 weeks ago

CodSpeed Performance Report

_{Comparing 125-begin-documenting-crate (c08ccf3) with main (3a35573)}

✅ 16 untouched benchmarks

codecov[bot] commented 3 weeks ago

Attention: Patch coverage is 90.00000% with 2 lines in your changes missing coverage. Please review.

:white_check_mark: All tests successful. No failed tests found.

Files	Patch %	Lines
src/path.rs	60.00%	2 Missing :warning: