docs(quickflat): add missing Returns, fix stale kwargs docs in view.py - #692
Open
AgarwalNilay wants to merge 2 commits into
Open
AgarwalNilay wants to merge 2 commits into
AgarwalNilay wants to merge 2 commits into
Conversation
Contributor
|
Can you rebase onto this branch? |
AgarwalNilay
force-pushed
the
docs/quickflat-view-docstrings
branch
from
August 22, 2026 01:31
936defc to
25e8d96
Compare
Contributor
|
Merge this after PR #682 , since it depends on changes from that branch. This branch may also need another rebase after that PR is merged. |
Contributor
Author
|
I'll fix this after PR #682 is merged and I can rebase |
make_figure had Parameters but no Returns section despite returning fig. make_png's docstring had drifted from make_figure's (duplicate `sampler` entry, and several params like `thick`/`depth`/`with_rois` group listed as if they were make_png's own args rather than kwargs forwarded to make_figure) -- reorganized under a documented **kwargs entry with each forwarded argument still individually described. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…arlier Changed 'duration' to 'frame_duration' to correctly reflect function argument in docstring.
AgarwalNilay
force-pushed
the
docs/quickflat-view-docstrings
branch
from
September 17, 2026 18:57
016b105 to
697b6b9
Compare
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
5 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.
make_figure had Parameters but no Returns section despite returning fig. make_png's docstring had drifted from make_figure's (duplicate
samplerentry, and several params likethick/depth/with_roisgroup listed as if they were make_png's own args rather than kwargs forwarded to make_figure) -- reorganized under a documented **kwargs entry with each forwarded argument still individually described.