Skip to content

Commit

Permalink
clarify return types
Browse files Browse the repository at this point in the history
  • Loading branch information
skyleilani committed Jan 18, 2024
1 parent a5f12fc commit 18dbdef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
7 changes: 3 additions & 4 deletions docs/mobility/navigation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ Get information regarding the current navigation service.

**Returns:**

- [`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.
- [`MapType.ValueType`](https://python.viam.dev/autoapi/viam/proto/service/navigation/index.html#viam.proto.service.navigation.GetPropertiesResponse): Information regarding the current navigation service.

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

**Returns:**

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

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

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

// Get the properties of your current service
navProperties, err := myNav.Properties(ctx)
navProperties, err := myNav.Properties(context.Background())
```

{{% /tab %}}
Expand Down
2 changes: 1 addition & 1 deletion docs/mobility/slam/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Get information regarding the current SLAM session.

**Returns:**

- 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.
- 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).

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).

Expand Down

0 comments on commit 18dbdef

Please sign in to comment.