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

Docs have a couple outdated examples #2390

Open
1 of 3 tasks
steadygaze opened this issue May 5, 2024 · 0 comments · May be fixed by #2460
Open
1 of 3 tasks

Docs have a couple outdated examples #2390

steadygaze opened this issue May 5, 2024 · 0 comments · May be fixed by #2460
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@steadygaze
Copy link

steadygaze commented May 5, 2024

Problem

I found a couple instances where the docs don't match the state of the codebase.

Presumably they're outdated due to refactoring. I made an attempt to find if the issue was already reported.

Steps To Reproduce

Steps to reproduce the behavior:

  • View the docs linked previously.

Expected behavior

All symbols mentioned in examples actually exist. Some kind of auto-compiling of examples would be pretty cool, if possibly overengineered.

Screenshots

N/A

Environment:

  • Current live docs in docs.rs for version 0.5.1.

Questionnaire
I don't actually know the answer (am still learning) or I would send a PR myself. I suspect the surrounding explanation might also need an update.

The source of render_element might be most of the answer for both. We have dom.rebuild(&mut NoOpMutations); which is probably the right thing if the vdom edits aren't important? The examples/ssr.rs is related but not really the answer we're looking for.

  • I don't have time to fix this right now, but maybe later
@ealmloff ealmloff self-assigned this May 30, 2024
@ealmloff ealmloff added bug Something isn't working documentation Improvements or additions to documentation labels May 30, 2024
@ealmloff ealmloff linked a pull request May 31, 2024 that will close this issue
29 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants