Skip to content

Fix confusing variable names in collection example docs #149

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
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix confusing variable names in collection example docs #149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07c8d9e
Initial plan
Copilot Apr 29, 2026
f8b5c7c
fix: improve collection example in docs to avoid variable name confusion
Copilot Apr 29, 2026
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
4 changes: 2 additions & 2 deletions docs/source/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,6 @@ Now lets add another SigMF Recording and associate them with a SigMF Collection:
}
}
)
streams = collection.get_stream_names()
sigmf = [collection.get_SigMFFile(stream) for stream in streams]
collection.tofile('example_zeros.sigmf-collection')

The SigMF Collection and its associated Recordings can now be loaded like this:
Expand All @@ -136,6 +134,8 @@ The SigMF Collection and its associated Recordings can now be loaded like this:

import sigmf
collection = sigmf.fromfile('example_zeros')
all_sigmffiles = [collection.get_SigMFFile(stream_name=stream_name)
for stream_name in collection.get_stream_names()]
Comment thread
777arc marked this conversation as resolved.
ci16_sigmffile = collection.get_SigMFFile(stream_name='example_ci16')
cf32_sigmffile = collection.get_SigMFFile(stream_name='example_cf32')

Expand Down
Loading