Summary

This pull request improves the documentation for the Router class in the calico.router package. It adds detailed explanations for each method and includes usage examples to help users understand how to use the Router class effectively.

Changes Made

• Added detailed comments and explanations for each method in the Router class.
• Included usage examples demonstrating basic navigation and route dispatching.
• Improved overall readability and clarity of the documentation.

Motivation

The existing documentation for the Router class was minimal and lacked detailed explanations and examples. This improvement aims to make it easier for new contributors and users to understand and use the Router class.

Related Issues

N/A

Checklist

• I have read the contributing guidelines.
• I have added tests that prove my fix is effective or that my feature works.
• I have added necessary documentation (if appropriate).
• Any dependent changes have been merged and published in downstream modules.