Fix confusing variable names in collection example docs#149
Open
Fix confusing variable names in collection example docs#149
Conversation
Agent-Logs-Url: https://github.com/sigmf/sigmf-python/sessions/c58e41e4-4910-4cd2-93ac-1482d20123b6 Co-authored-by: 777arc <5722532+777arc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix confusing example in collection README
Fix confusing variable names in collection example docs
Apr 29, 2026
There was a problem hiding this comment.
Pull request overview
Updates the advanced documentation’s SigMF Collection example to avoid shadowing the sigmf module and to place stream enumeration in a more relevant “loading” context.
Changes:
- Removed unused
streams/sigmfassignments from the collection creation example. - Added an example that enumerates stream names and loads all streams’
SigMFFileobjects when loading a collection. - Updated the
get_SigMFFilecall to use the explicitstream_name=keyword in the new comprehension.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
777arc
approved these changes
Apr 29, 2026
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
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.
The collection creation example shadowed the imported
sigmfmodule by reusing it as a variable name, and createdstreams/sigmfvariables that were never used. Theget_stream_names()call was also isolated from any meaningful context.Changes
streamsandsigmfassignments from the collection creation blockget_stream_names()usage into the loading example, where it's more illustrativeall_sigmffileswith explicitstream_name=kwarg