docs: Add docs for ToChildren
#2643
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spencewenski
force-pushed
the
to-children-docs
branch
from
967b453
to
c8983d1
Compare
As discussed in leptos-rs#2640, the `ToChildren` trait is useful to consumers who want to use the builder syntax. However, because it is currently annotated with `#[docs(hidden)]`, it's not visible in docs and also not included in Jetbrains's auto-complete. Add a doc comment for the `ToChildren` trait, including doc tests that demonstrate how to use the trait and how it compares to directly creating children.
spencewenski
force-pushed
the
to-children-docs
branch
from
c8983d1
to
d1c51e4
Compare
spencewenski
commented
Jun 22, 2024
Some examples were added to `ToChildren` that don't compile. This wasn't caught earlier because no errors were seen in the IDE when writing the examples. The issue was correctly caught by CI, however.
|
Hey @gbj , I believe I resolved the issue that was causing the checks to fail. Can you re-run the workflow and review when you get a chance? Thanks! |
|
LGTM. Thanks for the PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #2640, the
ToChildrentrait is useful to consumers who want to use the builder syntax. However, because it is currently annotated with#[docs(hidden)], it's not visible in docs and also not included in Jetbrains's auto-complete.Add a doc comment for the
ToChildrentrait, including doc tests that demonstrate how to use the trait and how it compares to directly creating children.