docs(cyw43): clarify Control::join() docs

Update doc comment to clarify that Control::join() can be used to join
networks using the provided options, not only open networks.
This commit is contained in:
Owen Phillips 2025-09-17 20:09:30 -07:00
parent c6371d7a9b
commit 0d568022be
2 changed files with 3 additions and 1 deletions

View File

@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
<!-- next-header -->
## Unreleased - ReleaseDate
- Updated documentation for Control::join() #4678
## 0.5.0 - 2025-08-28
- bump bt-hci to 0.4.0

View File

@ -295,7 +295,7 @@ impl<'a> Control<'a> {
self.ioctl_set_u32(Ioctl::SetPm, 0, mode_num).await;
}
/// Join an unprotected network with the provided ssid.
/// Join a network with the provided SSID using the specified options.
pub async fn join(&mut self, ssid: &str, options: JoinOptions<'_>) -> Result<(), Error> {
self.set_iovar_u32("ampdu_ba_wsize", 8).await;