Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7760858

Browse files
committedOct 11, 2024·
Make comments less AI vibes
1 parent 199c0cd commit 7760858

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed
 

‎lib/src/robot/client.dart

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class RobotClientOptions {
5555
}
5656

5757
/// {@category Viam SDK}
58-
/// Represents a discovery query in the SDK to query for components.
58+
/// Represents a discovery query in the SDK to query for discoverable components.
5959
class DiscoveryQuery {
6060
final String subtype;
6161
final String model;
@@ -280,10 +280,10 @@ class RobotClient {
280280
return await _client.getCloudMetadata(rpb.GetCloudMetadataRequest());
281281
}
282282

283-
/// Discover components connected to the robot using a more abstract SDK query.
283+
/// Discover components that the robot can connect to, given specific query metadata.
284284
///
285285
/// ```
286-
/// var queries = [DiscoveryQuery(subtype: 'camera', model: 'webcam', extra: {'resolution': '1080p'})];
286+
/// var queries = [DiscoveryQuery(subtype: 'camera', model: 'webcam', extra: {'username': 'admin', 'password': 'admin'})];
287287
/// var discoveredComponents = await machine.discoverComponents(queries);
288288
/// ```
289289
Future<rpb.DiscoverComponentsResponse> discoverComponents([List<DiscoveryQuery> queries = const []]) async {

0 commit comments

Comments
 (0)
Please sign in to comment.