Skip to content

Conversation

maximpertsov
Copy link
Contributor

@maximpertsov maximpertsov commented Jun 8, 2023

Add a very small summary of what sessions are and how to disable them, as well as links to a higher level description of sessions in RDK.

@maximpertsov maximpertsov marked this pull request as ready for review June 8, 2023 17:04
@maximpertsov maximpertsov requested a review from a team as a code owner June 8, 2023 17:04
@maximpertsov maximpertsov requested review from njooma, cheukt and dannenberg and removed request for cheukt June 8, 2023 17:04
Copy link
Member

@njooma njooma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor nit

README.md Outdated
### Sessions
Sessions are a safety feature that automatically cancel operations made by the python client if it loses connection to a robot. Sessions are enabled by default but can be disabled by setting `RobotClient.Options.disable_sessions = True`. Please see https://pkg.go.dev/go.viam.com/rdk/session for more details and server-side configuration options.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] Make the golang code a link: Please see the [session documentation](<URL>)for more details...

@maximpertsov maximpertsov merged commit 1290503 into viamrobotics:main Jun 8, 2023
@maximpertsov maximpertsov deleted the doc-sessions branch June 8, 2023 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants