Skip to content

Commit 18dbdef

Browse files
committed
clarify return types
1 parent a5f12fc commit 18dbdef

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

docs/mobility/navigation/_index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ Get information regarding the current navigation service.
447447

448448
**Returns:**
449449

450-
- [`MapType.ValueType`](https://python.viam.dev/autoapi/viam/proto/service/navigation/index.html#viam.proto.service.navigation.GetPropertiesResponse): Property information for the named navigation service.
450+
- [`MapType.ValueType`](https://python.viam.dev/autoapi/viam/proto/service/navigation/index.html#viam.proto.service.navigation.GetPropertiesResponse): Information regarding the current navigation service.
451451

452452
```python {class="line-numbers linkable-line-numbers"}
453453
my_nav = NavigationClient.from_robot(robot=robot, name="my_nav_service")
@@ -466,18 +466,17 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
466466

467467
**Returns:**
468468

469-
- [Properties](https://pkg.go.dev/go.viam.com/[email protected]/services/navigation#Properties): Information regarding the current navigation service.
469+
- [Properties](https://pkg.go.dev/go.viam.com/services/navigation#Properties): Information regarding the current navigation service.
470470
This includes the map type being ingested and used by the navigation service.
471471
- [(error)](https://pkg.go.dev/builtin#error): An error, if one occurred.
472472

473473
For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/services/navigation#Service).
474474

475475
```go {class="line-numbers linkable-line-numbers"}
476-
ctx := context.Background()
477476
myNav, err := navigation.FromRobot(robot, "my_nav_service")
478477

479478
// Get the properties of your current service
480-
navProperties, err := myNav.Properties(ctx)
479+
navProperties, err := myNav.Properties(context.Background())
481480
```
482481

483482
{{% /tab %}}

docs/mobility/slam/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Get information regarding the current SLAM session.
173173

174174
**Returns:**
175175

176-
- Tuple[[bool](https://docs.python.org/3/library/functions.html#bool), [MappingMode.ValueType](https://python.viam.dev/autoapi/viam/proto/service/slam/index.html#viam.proto.service.slam.MappingMode)]: A tuple containing a boolean which indicates whether the session is being run in the cloud, as well as the current session's mode.
176+
- Tuple[[bool](https://docs.python.org/3/library/functions.html#bool), [MappingMode.ValueType](https://python.viam.dev/autoapi/viam/proto/service/slam/index.html#viam.proto.service.slam.MappingMode)]: A tuple containing two objects: a boolean which indicates whether the session is being run in the cloud, and `MappingMode`, which represents the [various forms of mapping and localizing the current session can perform](/mobility/slam/cartographer/#use-a-live-machine).
177177

178178
For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/viam/services/slam/client/index.html#viam.services.slam.client.SLAMClient.get_properties).
179179

0 commit comments

Comments
 (0)