search

jamesmunns / postcard

A no_std + serde compatible message library for Rust
Apache License 2.0
930 stars 89 forks source link

Fix documentation of re-exports that have dedicated doc comment #106

Closed dtolnay closed 1 year ago

dtolnay commented 1 year ago

Fixes #65.

Rustdoc's behavior for doc attributes on pub use items is to concatenate the attributes from the pub use with the attributes from the original item. It looks like that is not what was intended in the documentation in postcard.

In this PR I have converted all pub use that had /// doc comments on them, into functions. This way they get to have their own self-contained documentation.

Before:

After:

netlify[bot] commented 1 year ago

Deploy Preview for cute-starship-2d9c9b canceled.

Name Link
Latest commit 7b7fe2084cd797b53730911ea238b268ee5aa63e
Latest deploy log https://app.netlify.com/sites/cute-starship-2d9c9b/deploys/64a5b4df9f71ba00086b554c
jamesmunns commented 1 year ago

Closed in favor of #107 as I didn't have permission to amend the PR. Thank you @dtolnay!