Add type hint for router in include_router method

[LIghtJUNction]

This pull request introduces a type annotation for the router parameter in the include_router method within robyn/__init__.py. The change improves code clarity and type safety.

• Added a type annotation to the router parameter in the include_router method, specifying it as "SubRouter".Add type hint for the 'router' parameter in include_router method.

Description

This PR fixes #

Summary

This PR does....

PR Checklist

Please ensure that:

• [ ] The PR contains a descriptive title
• [ ] The PR contains a descriptive summary of the changes
• [ ] You build and test your changes before submitting a PR.
• [x] You have added relevant documentation
• [ ] You have added relevant tests. We prefer integration tests wherever possible

Pre-Commit Instructions:

• [ ] Ensure that you have run the pre-commit hooks on your PR.

High-level PR Summary

This PR adds a type hint to the router parameter in the include_router method, specifying it as SubRouter. This is a minor improvement that enhances type safety and code readability without changing any functionality.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion

Order	File Path
1	robyn/__init__.py

Summary by CodeRabbit

• Documentation
  • Enhanced router documentation with expanded details on merging behavior, including route and middleware handling, along with warnings about potential mutations and conflicts.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
robyn	Error			Oct 19, 2025 4:57pm

💡 Enable Vercel Agent with $100 free credit for automated AI reviews

[sansyrox]

@LIghtJUNction , https://github.com/sparckles/Robyn/pull/1255/files#diff-8bbb55cf9793eb46fce842bf2abe71425ddb24af349e3114de42ef25f07b02fcL527

can you please update the docstring here?

[LIghtJUNction]

@LIghtJUNction , https://github.com/sparckles/Robyn/pull/1255/files#diff-8bbb55cf9793eb46fce842bf2abe71425ddb24af349e3114de42ef25f07b02fcL527

can you please update the docstring here?

👌🏻

[coderabbitai[bot]]

Walkthrough

The include_router method in the Robyn class received a type annotation for its router parameter and expanded docstring documentation describing merge behavior and warning about potential conflicts. No runtime behavior changed.

Changes

Cohort / File(s)	Summary
Type annotation and documentation update robyn/__init__.py	Added type hint router: "SubRouter" to include_router method signature; expanded docstring to describe route, middleware, websocket route, and dependency merging behavior with warnings about mutation and potential conflicts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Type hints bloom bright and clear, Documentation draws us near, The router method stands refined, With annotations well-aligned! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Add type hint for router in include_router method" accurately and clearly describes the primary change in the pull request. It is concise, specific, and directly related to the main modification shown in the raw summary—adding a type annotation to the router parameter in the include_router method. The title is neither vague nor misleading, and it provides sufficient context for developers reviewing the project history to understand the change at a glance.
Description Check	✅ Passed	The PR description contains meaningful content explaining the change—it clearly describes that a type annotation for the router parameter was added to improve code clarity and type safety. The description follows the repository's template structure, including Description, Summary, PR Checklist, and Pre-Commit Instructions sections. While some template fields like "This PR fixes #" and "This PR does...." are unfilled, and several checklist items remain unchecked, the core information about the change is present and descriptive. The description is not vague or incomplete in conveying what the PR accomplishes.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• [ ] 📝 Generate docstrings

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}