Skip to content

Commit

Permalink
Fix sentence in 0.20 migration guide (#8128)
Browse files Browse the repository at this point in the history
just a small fix for an incomplete sentence + minor clarification

* [x] yes
  • Loading branch information
Wumpf authored Nov 14, 2024
1 parent f248c20 commit fe840c0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/content/reference/migration/migration-0-20.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ In all SDKs:
* `connect()` is now deprecated in favor `connect_tcp()`
* `serve()` is now deprecated in favor `serve_web()`

The rationale behind this change is that it was common for users (see https://github.com/rerun-io/rerun/issues/7766).
The old methods will be removed in a future release.

The rationale behind this change is that it was easy to confuse what these functions do exactly:

We frequently had reports from users that were understandably expecting a serving process (`rr.serve()`) to be ready to accept connections from other processes (`rr.connect()`), when in reality the two things are completely unrelated: one is hosting a websocket server to be polled by the web-viewer, while the other is trying to connect to the TCP SDK comms pipeline.

Expand Down

0 comments on commit fe840c0

Please sign in to comment.