fix docs: Update import paths to use blech_clust.utils and array_lists for LFP data#802
Open
abuzarmahmood wants to merge 1 commit into
Open
fix docs: Update import paths to use blech_clust.utils and array_lists for LFP data#802abuzarmahmood wants to merge 1 commit into
abuzarmahmood wants to merge 1 commit into
Conversation
…s for LFP data - Updated all documentation files to use the correct import path: 'from blech_clust.utils.ephys_data.ephys_data import ephys_data' instead of 'from utils.ephys_data.ephys_data import ephys_data' - Updated LFP analysis code examples to use array_lists attributes: - lfp_array_list instead of lfp_array - stft_array_list instead of stft_array - amplitude_array_list instead of amplitude_array - phase_array_list instead of phase_array Updated files: - docs/reference/ephys-data.md - docs/reference/index.md - docs/getting-started/migration-guide/removed-features.md - utils/ephys_data/README.md
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
2 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.
Summary
This PR fixes issue #798 by updating the documentation to use the correct import path and array_lists for LFP data.
Changes Made
Updated import paths: Changed all documentation files to use the correct import path:
from blech_clust.utils.ephys_data.ephys_data import ephys_data(instead offrom utils.ephys_data.ephys_data import ephys_data)Updated LFP analysis code examples: Changed to use the
array_listsattributes as mentioned in the comment:lfp_array_listinstead oflfp_arraystft_array_listinstead ofstft_arrayamplitude_array_listinstead ofamplitude_arrayphase_array_listinstead ofphase_arrayFiles Updated
docs/reference/ephys-data.md- Main reference documentationdocs/reference/index.md- Reference index pagedocs/getting-started/migration-guide/removed-features.md- Migration guideutils/ephys_data/README.md- Module README