From 53d2878ddd163bef01ffa9d3fde2bdd417a21fea Mon Sep 17 00:00:00 2001 From: Lukas Bergdoll Date: Thu, 2 May 2024 19:26:34 +0200 Subject: [PATCH] Make it more clear that there are more functions being generated The initial brief, suggests that only a small number of functions are generated. This is in part historical. Docs.rs version doesn't link to sub-page link to avoid version confusions. --- README.md | 3 +++ src/lib.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index dc8e807..9c20bbc 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,9 @@ impl NewStructName { ) -> NewStructName { ... } fn borrow_owner<'a>(&'a self) -> &'a Owner { ... } fn borrow_dependent<'a>(&'a self) -> &'a Dependent<'a> { ... } + [...] + // See the macro level documentation for a list of all generated functions + // https://docs.rs/self_cell/latest/self_cell/macro.self_cell.html#generated-api. } impl Debug for NewStructName { ... } diff --git a/src/lib.rs b/src/lib.rs index d020723..a0a060d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -31,6 +31,9 @@ //! ) -> NewStructName { ... } //! fn borrow_owner<'a>(&'a self) -> &'a Owner { ... } //! fn borrow_dependent<'a>(&'a self) -> &'a Dependent<'a> { ... } +//! [...] +//! // See the macro level documentation for a list of all generated functions, +//! // section "Generated API". //! } //! //! impl Debug for NewStructName { ... }