search

arkivanov / Decompose

Kotlin Multiplatform lifecycle-aware business logic components (aka BLoCs) with routing (navigation) and pluggable UI (Jetpack Compose, SwiftUI, JS React, etc.)
https://arkivanov.github.io/Decompose
Apache License 2.0
2.25k stars 85 forks source link

Updated navigation KDocs #781

Closed arkivanov closed 2 months ago

arkivanov commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve updates to documentation comments across several Kotlin files within the decompose module. These modifications primarily focus on clarifying terminology related to navigation, specifically changing references from "key of the list" or "key of the stack" to "key of the navigation." Other minor textual adjustments were made to enhance clarity in method descriptions. The actual code functionality remains unchanged.

Changes

Files Change Summary
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/ChildSlotFactory.kt
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStackFactory.kt		 Documentation comments updated for key parameter from "key of the list/stack" to "key of the navigation."
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigation.kt		 Documentation comment updated to replace "PagesNavigationSource" and "SlotNavigationSource" with "NavigationSource."
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigator.kt
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigator.kt		 Minor textual adjustments in method comments for clarity without changing functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Navigation
    User->>Navigation: Request navigation
    Navigation->>Navigation: Update navigation key
    Navigation->>User: Confirm navigation

Poem

In the code where rabbits hop,
Changes made, they never stop.
Keys of navigation, clear and bright,
Guiding paths in day and night.
With each comment, clarity grows,
Hopping forward, where logic flows! 🐇✨

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 5555af7c7ae864c8510a61a73dba2a2593dc1d00 and 0099cc5ac796782f432a539555290d84c6ffa3fb.
Files selected for processing (8) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt (2 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt (1 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt (1 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/ChildSlotFactory.kt (2 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigation.kt (1 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigator.kt (1 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStackFactory.kt (2 hunks) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigator.kt (2 hunks)
Files skipped from review due to trivial changes (8) * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/ChildSlotFactory.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigation.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/slot/SlotNavigator.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStackFactory.kt * decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/StackNavigator.kt
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.