"Refactor" documentation

jaemk / cached

Rust cache structures and easy function memoization

MIT License

1.58k stars 95 forks source link

Closed Kijewski closed 1 year ago

Kijewski commented 1 year ago

Currently the bulk of the documentation was hidden in the source code, and it is not visible to rustdoc or rust-analyzer, i.e. when hovering over #[cached(…)] in e.g. vscode. This PR moves the documentation to the point of their definition, and makes the re-exports #[doc(inline)].
Hide implementation details used by cached_proc_macro
Document needed feature flags

jaemk commented 1 year ago

Awesome, thanks for fixing this!

Kijewski commented 1 year ago

You're welcome! Thank you for your library! :)

jaemk commented 1 year ago

changes released in v0.44.0 / v0.17.0 (macros)