Documentation review

[xpe]

First, thanks for this project. It looks well done!

I asked Claude Code Opus 4.5 to generate a documentation review and here it is:

https://gist.github.com/xpe/d4eff8e84bb925b20b1c8e103b919763

Before I asked for a full code review (of which the previous is only one part), I noticed the use of /* ... */ in places where doc comments would be more helpful.

[denispol]

Thanks for the first good issue!

Quick note on Claude's assessment: the table has errors, i.e. lib.rs already has //! module docs with examples (check lines 13-30).

Items:

• My /* */ comments are intentional internal dev notes. Doc comments (///, //!) supplement rather than replace them, and that's the pattern throughout.
• Will add # Errors sections to fallible public functions per clippy pedantic. Library support is coming soon, so this will matter more then.

Keeping open - WIP for library release.

[xpe]

@denispol Yes, I should have caveated that I didn't exhaustively check Claude's output for errors. So you are indeed wise to use it as a starting point only.