Skip to content

Commit

Permalink
Make it more clear that there are more functions being generated
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Voultapher committed May 2, 2024
1 parent de8f7ee commit 53d2878
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 { ... }
Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 { ... }
Expand Down

0 comments on commit 53d2878

Please sign in to comment.