Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
brentyi committed Jun 1, 2024
1 parent 87746f0 commit 7dac455
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
7 changes: 5 additions & 2 deletions src/viser/_gui_handles.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ class GuiContainerProtocol(Protocol):


class SupportsRemoveProtocol(Protocol):
def remove(self) -> None: ...
def remove(self) -> None:
...


@dataclasses.dataclass
Expand Down Expand Up @@ -341,6 +342,8 @@ def options(self, options: Iterable[StringType]) -> None:

@dataclasses.dataclass(frozen=True)
class GuiTabGroupHandle:
"""Handle for a tab group. Call :meth:`add_tab()` to add a tab."""

_tab_group_id: str
_labels: list[str]
_icons_html: list[str | None]
Expand Down Expand Up @@ -622,7 +625,7 @@ def remove(self) -> None:

@dataclasses.dataclass
class GuiPlotlyHandle:
"""Use to remove markdown."""
"""Use to update or remove markdown elements."""

_gui_api: GuiApi
_id: str
Expand Down
5 changes: 3 additions & 2 deletions src/viser/_scene_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1211,8 +1211,9 @@ def on_pointer_callback_removed(
) -> Callable[[], None]:
"""Add a callback to run automatically when the callback for a scene
pointer event is removed. This will be triggered exactly once, either
manually (via `remove_scene_pointer()`) or automatically (if the scene
pointer event is overridden with another call to `on_scene_pointer()`).
manually (via :meth:`remove_pointer_callback()`) or automatically (if
the scene pointer event is overridden with another call to
:meth:`on_pointer_event()`).
Args:
func: Callback for when scene pointer events are removed.
Expand Down

0 comments on commit 7dac455

Please sign in to comment.