Add missing API doc entries for save*, dump*, remove_channels, and scale_to_uV#4451
Open
ueeseer wants to merge 1 commit intoSpikeInterface:mainfrom
Open
Add missing API doc entries for save*, dump*, remove_channels, and scale_to_uV#4451ueeseer wants to merge 1 commit intoSpikeInterface:mainfrom
save*, dump*, remove_channels, and scale_to_uV#4451ueeseer wants to merge 1 commit intoSpikeInterface:mainfrom
Conversation
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
1 participant
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.
This fixes #4440 by surfacing several existing APIs that are currently hard to find from the generated documentation:
save/save_to_*dump/dump_to_*remove_channelsscale_to_uVThis is a docs-only PR. It does not change behavior; it just makes these existing entry points discoverable in the API docs.
Reviewer note
Cheap review: docs-only, concrete user-reported gap, and easy to verify in the rendered API reference.