Docs/webgl view docstrings - #712
Open
AgarwalNilay wants to merge 1 commit into
Open
Conversation
Contributor
show() had full Parameters/Other parameters/**kwargs docs but no Returns, despite conditionally returning a JSMixer client (when open_browser is True) or None. Co-Authored-By: Claude Sonnet 5 <[email protected]>
AgarwalNilay
force-pushed
the
docs/webgl-view-docstrings
branch
from
August 24, 2026 16:37
378a882 to
10ab531
Compare
Contributor
|
Was this due to volume.random changes? (I made those, I can’t see what would be breaking with them, all seems to run fine locally for me) Or something else?
M
… On Aug 22, 2026, at 8:20 PM, Aditya Vaidya ***@***.***> wrote:
kroq-gar78
left a comment
(gallantlab/pycortex#712)
<#712 (comment)>
Does this PR depend on changes from evi-hendrikx:docs/volume-docstrings (PR #711 <#711>) ? (The same question applies to #713 <#713> .) All these PRs are failing due to the Volume.random changes, and it's not clear if that is a necessary change for documentation in these modules.
—
Reply to this email directly, view it on GitHub <#712?email_source=notifications&email_token=ABJ6LQ4K3KBBW7LURCXSFHD5LJPHDA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMZYGM4TOMRWGE42M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSWGM33PORSXEX3DNRUWG2Y#issuecomment-5383972619>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABJ6LQ56C6FMQVWMKUU2TPL5LJPHDAVCNFSNUABEKJSXA33TNF2G64TZHMYTENBXGI3TAOJ3JFZXG5LFHM2TEMJZGUZDMMRRG6QXMAQ>.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS <https://github.com/notifications/mobile/ios/ABJ6LQ2UYV77JBEBPDFI4C35LJPHDA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMZYGM4TOMRWGE42M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSVGM33PORSXEX3JN5ZQ> and Android <https://github.com/notifications/mobile/android/ABJ6LQ6OGOI63YBLL5AMU435LJPHDA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTKMZYGM4TOMRWGE42M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSXGM33PORSXEX3BNZSHE33JMQ>. Download it today!
You are receiving this because you are subscribed to this thread.
|
Contributor
|
Hey Mark, yes think they were from the Do you mind opening up a new PR for that? Or if you let met know which branch it's on, I can do that myself. |
kroq-gar78
requested changes
Aug 25, 2026
Comment on lines
+388
to
+392
| 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. |
Contributor
There was a problem hiding this comment.
JSMixer if open_browser, else WebApp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
added return section to 'show' docstring