Fix imports, tweak docs

nerfstudio-project · Apr 14, 2023 · 3bf8cac · 3bf8cac
1 parent 377e61d
commit 3bf8cac
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 # viser
 
-`viser` is a library for interactive 3D visualization + Python, inspired by the
-best bits of the
+**[ [API Reference](https://brentyi.github.io/viser) ]**
+
+`viser` is a library for interactive 3D visualization + Python, inspired by
+our favorite bits of the
 [Nerfstudio viewer](https://github.com/nerfstudio-project/nerfstudio),
 [Pangolin](https://github.com/stevenlovegrove/Pangolin),
 [rviz](https://wiki.ros.org/rviz/), and

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -2,8 +2,8 @@
 
 |mypy| |nbsp| |pyright| |nbsp| |typescript| |nbsp| |versions|
 
-`viser` is a library for interactive 3D visualization + Python, inspired by the
-best bits of the
+`viser` is a library for interactive 3D visualization + Python, inspired by
+our favorite bits of the
 [Nerfstudio viewer](https://github.com/nerfstudio-project/nerfstudio),
 [Pangolin](https://github.com/stevenlovegrove/Pangolin),
 [rviz](https://wiki.ros.org/rviz/), and

diff --git a/viser/infra/__init__.py b/viser/infra/__init__.py
@@ -1,7 +1,7 @@
-"""Websocket-based communication infrastructure.
+""":mod:`viser.infra` provides WebSocket-based communication infrastructure.
 
 We implement abstractions for:
-- Launching a websocket+HTTP server on a shared port.
+- Launching a WebSocket+HTTP server on a shared port.
 - Registering callbacks for connection events and incoming messages.
 - Asynchronous message sending, both broadcasted and to individual clients.
 - Defining dataclass-based message types.

diff --git a/viser/infra/_infra.py b/viser/infra/_infra.py
@@ -84,9 +84,9 @@ class Server(MessageHandler):
     """Websocket server abstraction. Communicates asynchronously with client
     applications.
 
-    By default, all messages`) are broadcasted to all connected clients.
+    By default, all messages are broadcasted to all connected clients.
 
-    To send messages to an individual client, we can use `on_client_connect()`` to
+    To send messages to an individual client, we can use `on_client_connect()` to
     retrieve client handles.
     """
 

diff --git a/viser/infra/_messages.py b/viser/infra/_messages.py
@@ -11,7 +11,7 @@
 import numpy as onp
 
 if TYPE_CHECKING:
-    from ._core import ClientId
+    from ._infra import ClientId
 else:
     ClientId = Any