Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve GenerationalRef and GenerationalRefMut docs #3205

Open
ealmloff opened this issue Nov 13, 2024 · 1 comment · May be fixed by #3253
Open

Improve GenerationalRef and GenerationalRefMut docs #3205

ealmloff opened this issue Nov 13, 2024 · 1 comment · May be fixed by #3253
Labels
documentation Improvements or additions to documentation generation box Related to the generational box crate

Comments

@ealmloff
Copy link
Member

Feature Request

The documentation for generationalref and generationalrefmut are pretty sparse today. Generally, they should act like the inner type, but I have seen people in the discord run into issues trying to match on the ref type instead of the inner value. It should be possible to use dioxus relatively early into learning rust, so people may not have used types like RefCell and RwLock before

Implement Suggestion

Add documentation about:

  • Dynamically checked borrows
  • How to get the inner &T data with deref
  • Matching on the ref
@ealmloff ealmloff added documentation Improvements or additions to documentation generation box Related to the generational box crate labels Nov 13, 2024
@mattdm
Copy link

mattdm commented Nov 15, 2024

Yes please. I am running into exactly this. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation generation box Related to the generational box crate
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants