Skip to content

Conversation

@laevandus
Copy link
Contributor

@laevandus laevandus commented Oct 9, 2024

🎯 Goal

Incorrect documentation comment.

🛠 Implementation

I added a note to the ChatChannelViewModel.selectedChannelId that one can use ChatChannelScreen for presenting any channel. Missed the fact that the init is internal. Therefore, let's open it up or alternatively, remove that suggestion.

/// Creates a view model for the `ChatChannelListView`.
    ///
    /// - Parameters:
    ///   - channelListController: A controller providing the list of channels. If nil, a controller with default `ChannelListQuery` is created.
    ///   - selectedChannelId: The id of a channel to select. If the channel is not part of the channel list query, no channel is selected.
    ///   Consider using ``ChatChannelScreen`` for presenting channels what might not be part of the initial page of channels.

🧪 Testing

N/A

☑️ Checklist

  • I have signed the Stream CLA (required)
  • Changelog is updated with client-facing changes
  • New code is covered by unit tests
  • Affected documentation updated (docusaurus, tutorial, CMS (task created)

@laevandus laevandus added the documentation Improvements or additions to documentation label Oct 9, 2024
@laevandus laevandus requested a review from a team as a code owner October 9, 2024 08:18
@Stream-SDK-Bot
Copy link
Collaborator

Stream-SDK-Bot commented Oct 9, 2024

SDK Size

title develop branch diff status
StreamChatSwiftUI 7.14 MB 7.14 MB 0 KB 🟢

@github-actions
Copy link

github-actions bot commented Oct 9, 2024

1 Message
📖 There seems to be app changes but CHANGELOG wasn't modified.
Please include an entry if the PR includes user-facing changes.
You can find it at CHANGELOG.md.

Generated by 🚫 Danger

@sonarqubecloud
Copy link

@laevandus laevandus enabled auto-merge (squash) October 11, 2024 07:36
@laevandus laevandus merged commit e5b0be1 into develop Oct 11, 2024
11 checks passed
@laevandus laevandus deleted the docs/channel-screen branch October 11, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants