Skip to content

Docs/webgl view docstrings #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AgarwalNilay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs/webgl view docstrings #712

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cortex/webgl/view.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,14 @@ def show(
headless viewers. Default True
**kwargs
All additional keyword arguments are passed to the template renderer.

Returns
-------
client : JSMixer or None
If `open_browser` is True, a `JSMixer` client connected to the
opened browser tab, which can be used to control the viewer
programmatically (e.g. `client.getImage()`, `client.animate()`).
If `open_browser` is False, returns None.
Comment on lines +388 to +392

@kroq-gar78 kroq-gar78 Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

JSMixer if open_browser, else WebApp

"""

# populate default webshow args
Expand Down