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

Update router documentation #788

Merged
merged 3 commits into from
Feb 18, 2025
Merged

Update router documentation #788

merged 3 commits into from
Feb 18, 2025

Conversation

lukeh990
Copy link
Contributor

@lukeh990 lukeh990 commented Feb 4, 2025

This PR modifies the existing docs to better reflect the example provided in:
/examples/router/src/main.rs

I tried to follow the previous documentation and ran into trait bound errors with Copy. I found the example and managed to get it working. Figured that I would propose changing the docs to reflect that example better.

This commit modifies the existing docs to better reflect the example provided in /examples/router/src/main.rs
Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.42%. Comparing base (1f64418) to head (f1184af).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #788   +/-   ##
=======================================
  Coverage   71.42%   71.42%           
=======================================
  Files          45       45           
  Lines        6659     6659           
=======================================
  Hits         4756     4756           
  Misses       1903     1903           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukechu10 lukechu10 self-requested a review February 4, 2025 17:04
Copy link
Member

@lukechu10 lukechu10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for taking so long, I thought I had already reviewed this. Just made a small suggestion to reword the example section.

@lukeh990
Copy link
Contributor Author

@lukechu10 Thanks for getting back to me. I honestly sort of forgot I made this PR. And yeah, I like that new wording better.

@lukechu10 lukechu10 merged commit ac8c313 into sycamore-rs:main Feb 18, 2025
10 checks passed
@lukeh990 lukeh990 deleted the patch-1 branch February 18, 2025 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants